From 4f71f98008ffdbb89fa2fb9b8c19722d29a8f037 Mon Sep 17 00:00:00 2001 From: Jussi Kukkonen Date: Fri, 20 Aug 2021 15:52:57 +0300 Subject: [PATCH] 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 --- .gitignore | 2 +- .readthedocs.yaml | 2 +- docs/{sphinx/source => api}/api-reference.rst | 0 docs/{sphinx/source => api}/tuf.api.metadata.rst | 0 docs/{sphinx/source => api}/tuf.api.rst | 0 docs/{sphinx/source => api}/tuf.api.serialization.rst | 0 docs/{sphinx/source => api}/tuf.ngclient.config.rst | 0 docs/{sphinx/source => api}/tuf.ngclient.fetcher.rst | 0 docs/{sphinx/source => api}/tuf.ngclient.rst | 0 docs/{sphinx/source => api}/tuf.ngclient.updater.rst | 0 docs/{sphinx/source => }/conf.py | 5 ++--- docs/{sphinx/source => }/index.rst | 4 +++- tox.ini | 2 +- 13 files changed, 8 insertions(+), 7 deletions(-) rename docs/{sphinx/source => api}/api-reference.rst (100%) rename docs/{sphinx/source => api}/tuf.api.metadata.rst (100%) rename docs/{sphinx/source => api}/tuf.api.rst (100%) rename docs/{sphinx/source => api}/tuf.api.serialization.rst (100%) rename docs/{sphinx/source => api}/tuf.ngclient.config.rst (100%) rename docs/{sphinx/source => api}/tuf.ngclient.fetcher.rst (100%) rename docs/{sphinx/source => api}/tuf.ngclient.rst (100%) rename docs/{sphinx/source => api}/tuf.ngclient.updater.rst (100%) rename docs/{sphinx/source => }/conf.py (93%) rename docs/{sphinx/source => }/index.rst (91%) diff --git a/.gitignore b/.gitignore index d3590f0f..e988195f 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ build/* env/* # docs build directory -docs/sphinx/build/* +docs/build/* # global file patterns *.log diff --git a/.readthedocs.yaml b/.readthedocs.yaml index efe6db56..58dec995 100644 --- a/.readthedocs.yaml +++ b/.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: [] diff --git a/docs/sphinx/source/api-reference.rst b/docs/api/api-reference.rst similarity index 100% rename from docs/sphinx/source/api-reference.rst rename to docs/api/api-reference.rst diff --git a/docs/sphinx/source/tuf.api.metadata.rst b/docs/api/tuf.api.metadata.rst similarity index 100% rename from docs/sphinx/source/tuf.api.metadata.rst rename to docs/api/tuf.api.metadata.rst diff --git a/docs/sphinx/source/tuf.api.rst b/docs/api/tuf.api.rst similarity index 100% rename from docs/sphinx/source/tuf.api.rst rename to docs/api/tuf.api.rst diff --git a/docs/sphinx/source/tuf.api.serialization.rst b/docs/api/tuf.api.serialization.rst similarity index 100% rename from docs/sphinx/source/tuf.api.serialization.rst rename to docs/api/tuf.api.serialization.rst diff --git a/docs/sphinx/source/tuf.ngclient.config.rst b/docs/api/tuf.ngclient.config.rst similarity index 100% rename from docs/sphinx/source/tuf.ngclient.config.rst rename to docs/api/tuf.ngclient.config.rst diff --git a/docs/sphinx/source/tuf.ngclient.fetcher.rst b/docs/api/tuf.ngclient.fetcher.rst similarity index 100% rename from docs/sphinx/source/tuf.ngclient.fetcher.rst rename to docs/api/tuf.ngclient.fetcher.rst diff --git a/docs/sphinx/source/tuf.ngclient.rst b/docs/api/tuf.ngclient.rst similarity index 100% rename from docs/sphinx/source/tuf.ngclient.rst rename to docs/api/tuf.ngclient.rst diff --git a/docs/sphinx/source/tuf.ngclient.updater.rst b/docs/api/tuf.ngclient.updater.rst similarity index 100% rename from docs/sphinx/source/tuf.ngclient.updater.rst rename to docs/api/tuf.ngclient.updater.rst diff --git a/docs/sphinx/source/conf.py b/docs/conf.py similarity index 93% rename from docs/sphinx/source/conf.py rename to docs/conf.py index 935ff9f1..2b087620 100644 --- a/docs/sphinx/source/conf.py +++ b/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 ------------------------------------------------- diff --git a/docs/sphinx/source/index.rst b/docs/index.rst similarity index 91% rename from docs/sphinx/source/index.rst rename to docs/index.rst index 654b378f..99aaee15 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/index.rst @@ -14,4 +14,6 @@ systems. :maxdepth: 1 :caption: Contents: - api-reference + api/api-reference + CONTRIBUTORS + INSTALLATION \ No newline at end of file diff --git a/tox.ini b/tox.ini index 75d2117c..f7e1d7a5 100644 --- a/tox.ini +++ b/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