From deb0b24692389eda82b1578fd56ee310f9f20015 Mon Sep 17 00:00:00 2001 From: Tamas Gal <tgal@km3net.de> Date: Wed, 4 Nov 2020 17:30:28 +0100 Subject: [PATCH] Fix doc building issues --- {{cookiecutter.project_slug}}/.gitignore | 1 + {{cookiecutter.project_slug}}/doc/conf.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.project_slug}}/.gitignore b/{{cookiecutter.project_slug}}/.gitignore index f45794b..134043c 100644 --- a/{{cookiecutter.project_slug}}/.gitignore +++ b/{{cookiecutter.project_slug}}/.gitignore @@ -32,6 +32,7 @@ reports doc/_build/ doc/auto_examples/ doc/modules/ +!doc/modules/.gitkeep doc/api # Virtual env diff --git a/{{cookiecutter.project_slug}}/doc/conf.py b/{{cookiecutter.project_slug}}/doc/conf.py index 79e91d4..8c25c54 100644 --- a/{{cookiecutter.project_slug}}/doc/conf.py +++ b/{{cookiecutter.project_slug}}/doc/conf.py @@ -47,10 +47,10 @@ templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'version.py'] # AutoAPI -autoapi_type = 'python' +autoapi_type = "python" autoapi_dirs = ['../{{cookiecutter.project_slug}}'] -autoapi_ignore = ['*version.py*'] -autoapi_add_toctree_entry = True +autoapi_options = ["members", "undoc-members", "show-module-summary"] +autoapi_include_summaries = True # Gallery sphinx_gallery_conf = { -- GitLab