Reorganize documentation into namespace packages.

Author: tillahoffmann

.github/workflows/main.yml

@@ -36,9 +36,9 @@ jobs:
           pip install wheel
           pip install -r requirements/${{ matrix.python-version }}.txt
       - name: Build documentation
-        run: sphinx-build -nW docs docs/_build/html
+        run: sphinx-build -nW . docs/_build
       - name: Run doctests
-        run: sphinx-build -b doctest docs docs/_build/html
+        run: sphinx-build -b doctest . docs/_build
 
   build:
     strategy:

.readthedocs.yml

@@ -1,19 +1,13 @@
-# .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Read the Docs configuration file (see https://docs.readthedocs.io/en/stable/config-file/v2.html
+# for details).
 
 # Required
 version: 2
 
-# Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
-
-# Optionally build your docs in additional formats such as PDF and ePub
+  configuration: conf.py
 formats: all
-
-# Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: "3.7"
   install:
     - requirements: requirements/3.7.txt

README.rst

@@ -36,6 +36,10 @@
     'sphinx.ext.napoleon',
 ]
 
+# Configure autodoc to avoid excessively long fully-qualified names.
+add_module_names = False
+autodoc_typehints_format = "short"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -46,7 +50,7 @@
 source_suffix = '.rst'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'README'
 
 # General information about the project.
 project = u'testcontainers'