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.
JOJ0 · Jul 26, 2024 · 5378347 · 5378347
1 parent 337e99e
commit 5378347
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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: