Merge pull request #26 from AyanSinhaMahapatra/master

Adds Documentation Versioning, Command Line Options, Changelogs

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Author: pombredanne

README.md

@@ -1,4 +1,6 @@
-# aboutcode
+# AboutCode Documentation
+
+### What is AboutCode
 
 AboutCode is a suite of tools to uncover data ... about software and code:
 
@@ -8,16 +10,27 @@ AboutCode is a suite of tools to uncover data ... about software and code:
 
 These are important questions when there are millions of free and open source software components available on the web.
 
+### Documentation Build Status
+
+[![Build Status](https://travis-ci.org/nexB/aboutcode.svg?branch=master)](https://travis-ci.org/nexB/aboutcode)
+
+### Important Links 
+
 Our homepage lives at http://aboutcode.org
 
 Our documentation (in progress) lives at https://aboutcode.readthedocs.io/en/latest/ 
 
-AboutCode Group Email Addresses:
-•    Post: AboutCode@groups.io
-•    Join: https://groups.io/g/AboutCode/join
-•    Subscribe: AboutCode+subscribe@groups.io
-•    Unsubscribe: AboutCode+unsubscribe@groups.io
-•    Group Owner: AboutCode+owner@groups.io
+AboutCode Documentation Group Email Addresses:
+
+- Join: https://groups.io/g/AboutCode/join
+- Post: AboutCode@groups.io
+- Subscribe: AboutCode+subscribe@groups.io
+- Unsubscribe: AboutCode+unsubscribe@groups.io
+- Group Owner: AboutCode+owner@groups.io
+
+If you want to get in touch with the team with issues other than documentation, head to the gitter channel [here](https://gitter.im/aboutcode-org/discuss).
+
+### Projects
 
 Each AboutCode project has its own repository:
 

docs/source/aboutcode-docs/writing_good_commit_messages.rst

@@ -5,7 +5,7 @@ What is good commit message? We want to avoid this: https://xkcd.com/1296/
 
 Read these articles:
 
-- by @cbeams https://chris.beams.io/posts/git-commit/
+- by @cbeams `How to Write a Git Commit Message <https://chris.beams.io/posts/git-commit/>`_
 - this README from Linus Torvalds https://github.com/torvalds/subsurface-for-dirk/blob/0f58510ce0244513521296b75281fcc32f72a931/README#L73
 - from the Git book: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
 

docs/source/conf.py

@@ -57,6 +57,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+
+#html_static_path = ['_static']
 
 master_doc = 'index'

docs/source/doc_maintenance.rst

@@ -31,12 +31,12 @@ That will create an /aboutcode directory in your working directory.
 Now you can install the dependencies in a virtualenv::
 
     cd aboutcode
-    python3.6 -m venv .
+    virtualenv -p /usr/bin/python3.6 docs-venv
     source bin/activate
 
 Now you can install Sphinx and the format theme used by readthedocs::
 
-    pip install Sphinx sphinx_rtd_theme
+    pip install Sphinx sphinx_rtd_theme doc8
 
 Now you can build the HTML documents locally::
 

docs/source/index.rst

@@ -1,51 +1,67 @@
 AboutCode Documentation
 =======================
 
-Guide
-*****
+Aboutcode Projects
+******************
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    scancode-toolkit/index
    scancode-workbench/index
-   aboutcode-data/abcd
-   aboutcode-docs/home
    deltacode/index
+   aboutcode-docs/home
    aboutcode-toolkit/index
-   deltacode/index
-   license
+   aboutcode-data/abcd
+
+Documentation Guide
+*******************
+
+.. toctree::
+   :maxdepth: 2
+   
    help
+   license
    doc_maintenance
 
 
 Tutorial Documents
-==================
+******************
 
-Tutorial documents provide specific instructions to help you get started.
+.. toctree::
+   :maxdepth: 2
+   
+   scancode-toolkit/tutorials/index
 
 
 How-To Documents
-================
+****************
 
-How-To documents explain how to accomplish specific tasks.
+.. toctree::
+   :maxdepth: 2
+   
+   scancode-toolkit/how-to-guides/index
 
 
 Reference Documents
-===================
+*******************
 
-Reference documents describe application concepts in depth.
+.. toctree::
+   :maxdepth: 2
+   
+   scancode-toolkit/cli-reference/index
 
 
 Discussion Documents
-====================
-
-Discussion documents provide insights into integration of the application into your own software development life cycle.
+********************
 
+.. toctree::
+   :maxdepth: 2
+   
+   scancode-toolkit/explanations/index
 
 Indices and Tables
-==================
+******************
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`

docs/source/scancode-toolkit/cli-reference/help-text-options.rst

@@ -0,0 +1,2 @@
+Help text
+=========

docs/source/scancode-toolkit/cli-reference/index.rst

@@ -0,0 +1,18 @@
+**Command Line Interface Reference**
+====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   synopsis
+   help-text-options
+   list-options
+   simple-examples
+
+..
+   [To-Add]
+   core-options
+   output-format
+   output-filters-and-control
+   scan-options-pre
+   scan-options-post

docs/source/scancode-toolkit/cli-reference/list-options.rst

@@ -0,0 +1,2 @@
+All Available Options
+=====================

docs/source/scancode-toolkit/cli-reference/simple-examples.rst

@@ -0,0 +1,3 @@
+A Simple Example
+================
+

docs/source/scancode-toolkit/cli-reference/synopsis.rst

@@ -0,0 +1,4 @@
+Synopsis
+========
+
+