зеркало из https://github.com/microsoft/LightGBM.git
[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
This commit is contained in:
Родитель
55656f27e1
Коммит
f68e1b50fb
19
docs/conf.py
19
docs/conf.py
|
@ -81,15 +81,14 @@ autodoc_default_options = {
|
|||
"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/`
|
||||
autosummary_generate = True
|
||||
autosummary_generate = ['Python-API.rst']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
# source_suffix = ['.rst', '.md']
|
||||
# Only the class' docstring is inserted.
|
||||
autoclass_content = 'class'
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
@ -124,12 +123,6 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
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 ------------------------------
|
||||
|
||||
if C_API:
|
||||
|
|
Загрузка…
Ссылка в новой задаче