Unverified Commit f68e1b50 authored by Nikita Titov's avatar Nikita Titov Committed by GitHub
Browse files

[docs] limit number of files to scan for autosummary generation and reorganize conf.py (#2297)

* limit number of files to scan for autosummary generation

* reorganize conf.py
parent 55656f27
...@@ -81,15 +81,14 @@ autodoc_default_options = { ...@@ -81,15 +81,14 @@ autodoc_default_options = {
"show-inheritance": True, "show-inheritance": True,
} }
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# Generate autosummary pages. Output should be set with: `:toctree: pythonapi/` # Generate autosummary pages. Output should be set with: `:toctree: pythonapi/`
autosummary_generate = True autosummary_generate = ['Python-API.rst']
# Only the class' docstring is inserted.
autoclass_content = 'class'
# The suffix(es) of source filenames. # If true, `todo` and `todoList` produce output, else they produce nothing.
# You can specify multiple suffix as a list of string: todo_include_todos = False
# source_suffix = ['.rst', '.md']
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
...@@ -124,12 +123,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -124,12 +123,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'default' pygments_style = 'default'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# Both the class' and the __init__ method's docstring are concatenated and inserted.
autoclass_content = 'class'
# -- Configuration for C API docs generation ------------------------------ # -- Configuration for C API docs generation ------------------------------
if C_API: if C_API:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment