From 5378347053f4fd68629169d054d218fb9c6dc72b Mon Sep 17 00:00:00 2001 From: J0J0 Todos Date: Fri, 26 Jul 2024 10:24:43 +0200 Subject: [PATCH] Fix APIHelper class missing in Sphinx docs After moving APIHelper to its own file _helper.py in #137, the class was not found by Sphinx autodoc anymore, thus missing in the docs and we didn't catch the warning at build time. --- doc/source/conf.py | 2 +- doc/source/synadm.module.cli.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1b5ccf1c..0438b357 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,7 +65,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] html_theme_options = { 'collapse_navigation': True, diff --git a/doc/source/synadm.module.cli.rst b/doc/source/synadm.module.cli.rst index cdd4dc84..428ede42 100644 --- a/doc/source/synadm.module.cli.rst +++ b/doc/source/synadm.module.cli.rst @@ -15,7 +15,7 @@ package that is worth mentioning and generating documentation for, is the backend code in :mod:`synadm.api`: -.. automodule:: synadm.cli +.. automodule:: synadm.cli._helper :members: APIHelper :undoc-members: :show-inheritance: