docs: Move the sphinx root to docs/

This allows using existing documentation in the published documentation
without
* moving the existing docs (which would break external links)
* tricks like symlinks that create issues with relative links

Put the api reference files into a subdirectory to avoid polluting the
main docs/ directory.

Include "Installation" and "Instructions for Contributors" in the
published documentation.

Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>

.gitignore

@@ -4,7 +4,7 @@ build/*
 env/*
 
 # docs build directory
-docs/sphinx/build/*
+docs/build/*
 
 # global file patterns
 *.log

.readthedocs.yaml

@@ -8,7 +8,7 @@ version: 2
 # Build documentation with Sphinx
 sphinx:
    builder: html
-   configuration: docs/sphinx/source/conf.py
+   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF
 formats: []

docs/conf.py

@@ -12,7 +12,7 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..')))
+sys.path.insert(0, os.path.abspath(os.path.join('..')))
 
 import tuf
 
@@ -38,8 +38,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
+exclude_patterns = ['GETTING_STARTED.rst', 'OVERVIEW.rst', 'TAP.rst']
 
 # -- Options for HTML output -------------------------------------------------
 

docs/index.rst

@@ -14,4 +14,6 @@ systems.
    :maxdepth: 1
    :caption: Contents:
    
-   api-reference
+   api/api-reference
+   CONTRIBUTORS
+   INSTALLATION

tox.ini

@@ -61,4 +61,4 @@ deps =
 
 changedir = {toxinidir}
 commands =
-    sphinx-build -b html docs/sphinx/source docs/sphinx/build/html
+    sphinx-build -b html docs docs/build/html