Fixed #120 - Update RTD

 * The default RTD for aboutcode-toolkit should be at
https://aboutcode-toolkit.readthedocs.io/en/latest/index.html

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

docs/source/_static/theme_overrides.css

@@ -99,6 +99,7 @@ div.custom-admonition-important.admonition {
     color: #000000;
     background: #ffff66;
     background: #ffff99;
+    background: #fff3cd;
     border-radius: 5px 5px 0px 0px;
     border-bottom: solid 1px #e8e8e8;
 }
@@ -117,8 +118,12 @@ div.custom-admonition-caution.admonition {
 /* note */
 .custom-admonition-note  .admonition-title {
     color: #ffffff;
+    /* color: #000000; */
     background: #3399ff;
     background: #006bb3;
+    background: #cce5ff;
+    background: #b3d7ff;
+    background: #2196f3;
     border-radius: 5px 5px 0px 0px;
 }
 div.custom-admonition-note.admonition {
@@ -127,6 +132,8 @@ div.custom-admonition-note.admonition {
     background: #ffffff;
     border: solid 1px #e8e8e8;
     border: solid 1px #cccccc;
+    /* border: solid 1px #80bdff; */
+    /* border: solid 1px #2196f3; */
     border-radius: 5px;
     /* box-shadow: 5px 5px 18px #d8d8d8; */
     box-shadow: 1px 1px 5px 3px #d8d8d8;
@@ -136,9 +143,20 @@ div.custom-admonition-note.admonition {
 /* todo */
 .custom-admonition-todo  .admonition-title {
     color: #000000;
+    color: #cc0000;
     background: #cce6ff;
+    background: #ffcc00;
+    background: #ffeb99;
+    background: #ccffff;
+    background: #ffd9b3;
+    background: #ffffff;
     border-radius: 5px 5px 0px 0px;
     border-bottom: solid 1px #99ccff;
+    border-bottom: solid 1px #ffcc00;
+    border-bottom: solid 1px #ffeb99;
+    border-bottom: solid 1px #e8e8e8;
+    border-bottom: solid 1px #ffd9b3;
+    border-bottom: solid 1px #d8d8d8;
 }
 div.custom-admonition-todo.admonition {
     color: #000000;
@@ -147,6 +165,10 @@ div.custom-admonition-todo.admonition {
     border: solid 1px #e8e8e8;
     border: solid 1px #cccccc;
     border: solid 1px #99ccff;
+    border: solid 1px #ffcc00;
+    border: solid 1px #ffeb99;
+    border: solid 1px #ffd9b3;
+    border: solid 1px #cc0000;
     border-radius: 5px;
     /* box-shadow: 5px 5px 18px #d8d8d8; */
     box-shadow: 1px 1px 5px 3px #d8d8d8;
@@ -194,17 +216,21 @@ div.rst-content {
 .rst-content .guilabel {
     /* border: 1px solid #7fbbe3; */
     /* border: 1px solid #e7f2fa; */
-    border: 1px solid #ffff99;
+    /* border: 1px solid #ffff99; */
     /* border: 1px solid #ccffcc; */
     /* border: 1px solid #f2f2f2; */
     /* border: 1px solid #e6f2ff; */
+    /* border: 1px solid #fff3cd; */
+    border: 1px solid #ccffff;
 
     /* background: #e7f2fa; */
     /* background: #e6ffff; */
-    background: #ffff99;
+    /* background: #ffff99; */
     /* background: #ccffcc; */
     /* background-color: #f2f2f2; */
     /* background: #e6f2ff; */
+    /* background: #fff3cd; */
+    background: #ccffff;
 
     /* font-size: 80%; */
     font-size: 100%;
@@ -361,3 +387,31 @@ code, .rst-content tt, .rst-content code {
     margin-bottom: 0px;
     line-height: 24px;
 }
+
+/* === */
+
+/* this is used by the genindex added via layout.html (see source/_templates/) to sidebar toc */
+.reference.internal.toc-index {
+    color: #d9d9d9;
+}
+
+.reference.internal.toc-index.current {
+    background-color: #ffffff;
+    color: #000000;
+    font-weight: bold;
+}
+
+.toc-index-div {
+    border-top: solid 1px #666666;
+    margin-top: 10px;
+    padding-top: 10px;
+}
+
+/* The next 2 fix the poor vertical spacing in genindex.html (the alphabetized index) */
+.indextable.genindextable {
+    margin-bottom: 20px;
+}
+
+div.genindex-jumpbox {
+    margin-bottom: 20px;
+}

docs/source/general.rst

@@ -4,23 +4,20 @@
 General
 =======
 
-.. contents::
-   :depth: 3
-
 AboutCode Toolkit Defined
 =========================
 
-AboutCode Toolkit is a tool for your software development team to document your code inside your codebase, typically in preparation for a product release, side-by-side with the actual code. AboutCode Toolkit files have a simple, standard format that identifies components and their associated licenses. The current AboutCode Toolkit subcommands are:
+AboutCode Toolkit is a tool for your software development team to document your code inside your codebase, typically in preparation for a product release, side-by-side with the actual code. ABOUT file(s) have a simple, standard format that identifies components and their associated licenses. The current AboutCode Toolkit subcommands are:
 
--   **attrib**: Generate a Product Attribution notice document (HTML format) from your AboutCode Toolkit files. You can also generate documents for other purposes (such as a License Reference) by varying your input control file and your template.
+-   **attrib**: Generate a Product Attribution notice document (HTML format) from your ABOUT file(s). You can also generate documents for other purposes (such as a License Reference) by varying your input control file and your template.
 
--   **check**: A simple command to validate the AboutCode Toolkit files and output errors/warnings if any on the terminal.
+-   **check**: A simple command to validate the ABOUT file(s) and output errors/warnings if any on the terminal.
 
--   **collect_redist_src**: A command to collect and copy sources that have 'redistribute' flagged as 'True' in AboutCode Toolkit files or from an inventory.
+-   **collect_redist_src**: A command to collect and copy sources that have 'redistribute' flagged as 'True' in ABOUT file(s) or from an inventory.
 
--   **gen**: Create AboutCode Toolkit files from a Software Inventory file (.csv or .json format) which is typically created from a software audit, and insert these AboutCode Toolkit files into your codebase. You can regenerate the AboutCode Toolkit files from a new Software Inventory file whenever you make changes.
+-   **gen**: Create ABOUT file(s) from a Software Inventory file (.csv or .json format) which is typically created from a software audit, and insert these AboutCode Toolkit files into your codebase. You can regenerate the AboutCode Toolkit files from a new Software Inventory file whenever you make changes.
 
--   **inventory**: Generate a Software Inventory list (.csv or .json format) from your codebase based on your AboutCode Toolkit files. Note that this Software Inventory will only include components that have AboutCode Toolkit data. In another word, if you do not create AboutCode Toolkit files for your own original software components, these components will not show up in the generated inventory.
+-   **inventory**: Generate a Software Inventory list (.csv or .json format) from your codebase based on ABOUT file(s). Note that this Software Inventory will only include components that have AboutCode Toolkit data. In another word, if you do not create AboutCode Toolkit files for your own original software components, these components will not show up in the generated inventory.
 
 -   **transform**: A command to transform an input CSV/JSON by applying renaming and/or filtering and then output to a new CSV/JSON file.
 
@@ -38,8 +35,8 @@ Some key terminology that applies to AboutCode Toolkit tool usage:
 
 -   **Product BOM or BOM** - means a subset list of the components in a Development codebase (Software Inventory) that are Deployed on a particular Product Release (a Product Bill of Materials).
 
-Using gen to Generate AboutCode Toolkit Files
-=============================================
+Using gen to Generate ABOUT file(s)
+===================================
 
 Prepare Your Software Inventory for gen Standard Field Names
 ------------------------------------------------------------
@@ -217,10 +214,10 @@ For instance with this configuration, the target file will not contain the "type
                 - type
                 - temp
 
-Run gen to Generate AboutCode Toolkit Files
--------------------------------------------
+Run gen to Generate ABOUT file(s)
+---------------------------------
 
-When your software inventory is ready, you can save it as a .csv or .json file, and use it as input to run gen to generate your AboutCode Toolkit files. The official gen parameters are defined here: :ref:`reference`
+When your software inventory is ready, you can save it as a .csv or .json file, and use it as input to run gen to generate ABOUT file(s). The official gen parameters are defined here: :ref:`reference`
 
 Here is an example of a gen command:
 
@@ -238,7 +235,7 @@ This gen example command does the following:
 
 -   Specifies a target output directory.
 
-Review your generated AboutCode Toolkit files to determine if they meet your requirements. Here is a simple example of a linux-redhat-7.2.ABOUT file that documents the directory /linux-redhat-7.2/ :
+Review the generated ABOUT file(s) to determine if it meets your requirements. Here is a simple example of a linux-redhat-7.2.ABOUT file that documents the directory /linux-redhat-7.2/ :
 
         ..  code-block:: none
 
@@ -255,7 +252,7 @@ Review your generated AboutCode Toolkit files to determine if they meet your req
                 owner: Red Hat
                 redistribute: Y
 
-You can make the appropriate changes to your input software inventory and then run gen as often as necessary to replace the generated AboutCode Toolkit files with the improved output.
+You can make appropriate changes to your input software inventory and then run gen as often as necessary to replace the ABOUT file(s) with the improved version.
 
 Using attrib to Generate a Product Attribution Notice Package
 =============================================================
@@ -378,7 +375,7 @@ In summary, you can start with simple, cosmetic customizations to the default_ht
 Run attrib to Generate a Product Attribution Notice Package
 -----------------------------------------------------------
 
-When you have generated the AboutCode Toolkit files by gen, you can then run attrib to generate your product attribution notice package. The official attrib parameters are defined here: :ref:`reference`
+When you have generated ABOUT file(s) by gen, you can then run attrib to generate your product attribution notice package. The official attrib parameters are defined here: :ref:`reference`
 
 Here is an example of a attrib command:
 
@@ -388,7 +385,7 @@ Note that this example attrib command does the following:
 
 -   Activates the --template option to specify a custom output template.
 
--   Specifies the path of the AboutCode Toolkit files needed to generate the output document.
+-   Specifies the path of the ABOUT file(s) that use to generate the output attribution.
 
 -   Specifies the full path (include file name) of the output document to be generated.
 
@@ -397,12 +394,12 @@ A successful execution of attrib will create a .html (or .json depends on the te
 Using inventory to Generate a Software Inventory
 ================================================
 
-Generate a Software Inventory of Your Codebase from AboutCode Toolkit Files
----------------------------------------------------------------------------
+Generate a Software Inventory of Your Codebase from ABOUT file(s)
+-----------------------------------------------------------------
 
-One of the major features of the ABOUT File specification is that the .ABOUT files are very simple text files that can be created, viewed and edited using any standard text editor. Your software development and maintenance processes may require or encourage your software developers to maintain .ABOUT files and/or associated text files manually. For example, when a developer addresses a software licensing issue with a component, it is appropriate to adjust the associated AboutCode Toolkit files manually.
+One of the major features of the ABOUT File specification is that the .ABOUT files are very simple text files that can be created, viewed and edited using any standard text editor. Your software development and maintenance processes may require or encourage your software developers to maintain .ABOUT files and/or associated text files manually. For example, when a developer addresses a software licensing issue with a component, it is appropriate to adjust the associated ABOUT file(s) manually.
 
-If your organization adopts the practice of manually creating and maintaining AboutCode Toolkit files, you can easily re-create your software inventory from your codebase using inventory. The official inventory parameters are defined here: :ref:`reference`
+If your organization adopts the practice of manually creating and maintaining ABOUT file(s), you can easily re-create your software inventory from your codebase using inventory. The official inventory parameters are defined here: :ref:`reference`
 
 A successful execution of inventory will create a complete software inventory in .csv format or .json format based on defined format.
 

docs/source/home.rst

@@ -0,0 +1,153 @@
+.. _home:
+
+=================
+AboutCode Toolkit
+=================
+
+Introduction
+------------
+The AboutCode Toolkit and ABOUT files provide a simple way to document the
+origin, license, usage and other important or interesting information about
+third-party software components that you use in your project.
+
+You start by storing ABOUT files (a small YAML formatted text file with field/value pairs)
+side-by-side with each of the third-party software components you use.
+Each ABOUT file documents origin and license for one software.
+There are many examples of ABOUT files (valid or invalid) in the testdata/
+directory of the whole repository.
+
+The current version of the AboutCode Toolkit can read these ABOUT files so that you
+can collect and validate the inventory of third-party components that you use.
+
+In addition, this tool is able to generate attribution notices and
+identify redistributable source code used in your project to help you comply
+with open source licenses conditions.
+
+This version of the AboutCode Toolkit follows the ABOUT specification version 3.2.1 at:
+https://aboutcode-toolkit.readthedocs.io/en/latest/specification.html
+
+
+Build and tests status
+----------------------
+
++-------+-----------------+--------------+
+|Branch | **Linux/macOS** | **Windows**  |
++=======+=================+==============+
+|Master | |master-posix|  | |master-win| |
++-------+-----------------+--------------+
+|Develop| |devel-posix|   | |devel-win|  |
++-------+-----------------+--------------+
+
+
+REQUIREMENTS
+------------
+The AboutCode Toolkit is tested with Python 3.6.2 or above only on Linux, Mac and Windows.
+You will need to install a Python interpreter if you do not have one already
+installed.
+
+On Linux and Mac, Python is typically pre-installed. To verify which
+version may be pre-installed, open a terminal and type:
+
+    python --version
+
+On Windows or Mac, you can download the latest Python here:
+    https://www.python.org/downloads/
+
+Download the .msi installer for Windows or the .dmg archive for Mac.
+Open and run the installer using all the default options.
+
+
+INSTALLATION
+------------
+Checkout or download and extract the AboutCode Toolkit from:
+    https://github.com/nexB/aboutcode-toolkit/
+
+To install all the needed dependencies in a virtualenv, run (on posix):
+    source configure
+or on windows:
+    configure
+
+
+Activate the virtualenv
+-----------------------
+To activate the virtualenv, run (on posix):
+    source bin/activate
+or on windows:
+    bin\\activate
+
+
+Deactivate the virtualenv
+-------------------------
+To deactivate the virtualenv, run (on both posix and windows):
+    deactivate
+
+
+VERSIONING SCHEMA
+-----------------
+Starting at AboutCode version 4.0.0, the AboutCode Toolkit will follow SemVer for the versioning schema.
+
+i.e. MAJOR.MINOR.PATCH format
+    1. MAJOR version when making incompatible API changes,
+    2. MINOR version when making functionality in a backwards compatible manner, and
+    3. PATCH version when making backwards compatible bug fixes.
+
+
+REFERENCE
+---------
+See https://github.com/nexB/aboutcode-toolkit/blob/master/REFERENCE.rst for reference
+on aboutcode-toolkit usage.
+
+
+TESTS and DEVELOPMENT
+---------------------
+To install all the needed development dependencies, run (on posix):
+    source configure etc/conf/dev
+or on windows:
+    configure etc/conf/dev
+
+To verify that everything works fine you can run the test suite with:
+    py.test
+
+
+HELP and SUPPORT
+----------------
+If you have a question or find a bug, enter a ticket at:
+
+    https://github.com/nexB/aboutcode-toolkit
+
+For issues, you can use:
+
+    https://github.com/nexB/aboutcode-toolkit/issues
+
+
+SOURCE CODE
+-----------
+The AboutCode Toolkit is available through GitHub. For the latest version visit:
+    https://github.com/nexB/aboutcode-toolkit
+
+
+HACKING
+-------
+We accept pull requests provided under the same license as this tool.
+You agree to the http://developercertificate.org/ 
+
+
+LICENSE
+-------
+The AboutCode Toolkit is released under the Apache 2.0 license.
+See (of course) the about.ABOUT file for details.
+
+
+.. |master-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=master
+    :target: https://travis-ci.org/nexB/aboutcode-toolkit
+    :alt: Linux Master branch tests status
+.. |devel-posix| image:: https://api.travis-ci.org/nexB/aboutcode-toolkit.png?branch=develop
+    :target: https://travis-ci.org/nexB/aboutcode-toolkit
+    :alt: Linux Develop branch tests status
+
+.. |master-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/master?png=true
+    :target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit
+    :alt: Windows Master branch tests status
+.. |devel-win| image:: https://ci.appveyor.com/api/projects/status/uwj2gh8i9ga1mqwn/branch/develop?png=true
+    :target: https://ci.appveyor.com/project/nexB/aboutcode-toolkit
+    :alt: Windows Develop branch tests status

docs/source/index.rst

@@ -7,6 +7,7 @@ Welcome to the AboutCode Toolkit's Documentation.
 .. toctree::
    :maxdepth: 2
 
+   AboutCode Toolkit <home.rst>
    General <general.rst>
    Specification <specification.rst>
    Reference <reference.rst>