Commits

Ville Suoranta authored d9fe966b07a
Add autoapi config

docs/source/conf.py

Modified
29 29
30 30 # Add any Sphinx extension module names here, as strings. They can be
31 31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 32 # ones.
33 33 extensions = [ 'sphinx.ext.autodoc',
34 34 'sphinx.ext.napoleon',
35 35 'sphinx.ext.todo',
36 36 'autoapi.extension'
37 37 ]
38 38
39 +# configure autoapi
40 +autoapi_dirs = ['../../casatablebrowser' ]
41 +autoapi_add_toctree_entry = False
42 +autoapi_generate_api_docs = True
43 +autoapi_root = '_api/autoapi'
44 +autoapi_options = ['show-module-summary']
45 +autoapi_template_dir = '_templates'
46 +autoapi_keep_files = True
47 +
39 48 # Add any paths that contain templates here, relative to this directory.
40 49 templates_path = ['_templates']
41 50
42 51 # List of patterns, relative to source directory, that match files and
43 52 # directories to ignore when looking for source files.
44 53 # This pattern also affects html_static_path and html_extra_path.
45 54 exclude_patterns = []
46 55
47 56
48 57 # -- Options for HTML output -------------------------------------------------

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut