Fix docs build

Fix the command to build the docs to ensure that they are created at the right location so that they show up in readthedocs. Signed-off-by: Urvashi Mohnani <[email protected]>
containers · Nov 7, 2023 · d64558e · d64558e
1 parent f786eea
commit d64558e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -76,7 +76,7 @@ docs:
 	# -D language=en : define language as en
 	# . : source directory
 	# _build/html : target
-	cd _build/doctrees && python3 -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en . _build/html
+	python3 -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en _build/doctrees _build/html
 
 .PHONY: rpm
 rpm: ## Build rpm packages

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -39,7 +39,7 @@
 # sphinx.ext.napoleon: Support for NumPy and Google style docstrings
 # sphinx.ext.viewcode: Add links to highlighted source code
 # isort: unique-list
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.napoleon', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -51,6 +51,9 @@
 exclude_patterns = [
     'podman.api.*rst',
     'podman.rst',
+    'podman.version.rst',
+    'podman.tlsconfig.rst',
+    'podman.errors.rst',
 ]
 
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -53,14 +53,18 @@ Example
    :glob:
    :hidden:
 
+   podman.domain.config*
    podman.domain.containers
    podman.domain.containers_manager
    podman.domain.images
    podman.domain.images_manager
+   podman.domain.ipam*
    podman.domain.events*
+   podman.domain.manager
    podman.domain.manifests*
    podman.domain.networks*
    podman.domain.pods*
+   podman.domain.registry_data*
    podman.domain.secrets*
    podman.domain.system*
    podman.domain.volume*