ScanCode Toolkit Documentation
==============================

Welcome to ScanCode Toolkit Documentation!

If you are new to ScanCode Toolkit, start here:

.. toctree::
   :maxdepth: 2

   getting-started/newcomer

Here's a list of more Documentation Pages:

- A :ref:`cli_synopsis` of ScanCode Command Line Options
- Tutorials on :ref:`how_to_run_a_scan` and :ref:`how_to_visualize_scan_results`
- An exhaustive List of :ref:`cli_list_options`
- Documentation on :ref:`contrib_code_dev`
- Documentation on :ref:`plugin_arch`
- :ref:`faq`

----

Getting Started
---------------

.. toctree::
   :maxdepth: 2

   getting-started/index

----

Command Line Options Reference
------------------------------

Reference documents describe the Command Line options, and application concepts in depth.

.. toctree::
   :maxdepth: 2

   cli-reference/index

----

Tutorials
---------

Tutorial documents provide specific instructions to help you get started.

.. toctree::
   :maxdepth: 2

   tutorials/index

----

How-To Documents
----------------

How-To documents explain how to accomplish specific tasks.

.. toctree::
   :maxdepth: 2

   how-to-guides/index

----

Contribute To ScanCode
----------------------

.. toctree::
   :maxdepth: 2

   contribute/index

----

Plugins Documentation
---------------------

.. toctree::
   :maxdepth: 2

   plugins/index

----

Miscellaneous Documents
-----------------------

.. toctree::
   :maxdepth: 2

   misc/index


Reference Documents
--------------------

Reference documents provide reference pages for technical reference information
about ScanCode Toolkit, including how it works and supported features.

.. toctree::
   :maxdepth: 2

   reference/index


----

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _improve_docs:

.. include::  /rst_snippets/improve_docs.rst
