You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
classMyClass:
""" This is my base class. """defa_method(self):
""" This is a method. """pass
and conf.py is as follows:
project='TestCase'author='Martin F N Cooper'copyright='2024, '+authorextensions= [
'autoapi.extension'
]
autoapi_dirs= ['../tc']
# The following is the default set of options from the docs. This works.#autoapi_options = [ 'members', 'undoc-members', 'private-members', 'show-inheritance', 'show-module-summary', 'special-members', 'imported-members' ]# The following is the same list but without 'undoc-members'. This breaks.autoapi_options= [ 'members', 'private-members', 'show-inheritance', 'show-module-summary', 'special-members', 'imported-members' ]
templates_path= ['_templates']
When running make html in the docs directory, I get:
Extension error (autoapi.extension):Handler <function run_autoapi at 0x10783f700> for event 'builder-inited' threw an exception (exception: [Errno 2] No such file or directory: '/Users/<rest_of_path>/docs/autoapi/index.rst')
As noted in the conf.py comments, it works if I use the complete list of defaults. If I omit the options specification entirely, it behaves the same as if I specify those defaults (not surprisingly). But if I specify any options, I must include 'undoc-members' or it fails. This is particularly odd since, in this example, I don't actually have any undocumented members.
The text was updated successfully, but these errors were encountered:
Closing as a duplicate of #448. You can omit undoc-members but you must document the module, otherwise it is considered undocumented and therefore not rendered.
This is rather a bizarre issue that I'm seeing with sphinx-autoapi version 3.1.1.
Simple test case with directory structure as follows:
init.py contains only:
and conf.py is as follows:
When running
make html
in the docs directory, I get:As noted in the
conf.py
comments, it works if I use the complete list of defaults. If I omit the options specification entirely, it behaves the same as if I specify those defaults (not surprisingly). But if I specify any options, I must include 'undoc-members' or it fails. This is particularly odd since, in this example, I don't actually have any undocumented members.The text was updated successfully, but these errors were encountered: