From d64558e97fab289e67906b2ca5e61f3a905df277 Mon Sep 17 00:00:00 2001 From: Urvashi Mohnani Date: Tue, 7 Nov 2023 07:46:42 -0500 Subject: [PATCH] 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 --- Makefile | 2 +- docs/source/conf.py | 5 ++++- docs/source/index.rst | 4 ++++ 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index eb56753a..0478f123 100644 --- 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 index c593d8b3..42ea49ef 100644 --- 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 index 3fdbc6a8..7e0fa609 100644 --- 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*