100 lines
3.2 KiB
Python
100 lines
3.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
import musicbrainzapi
|
|
from musicbrainzapi.__version__ import __version__
|
|
import sphinx_rtd_theme
|
|
import sphinx_click
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'musicbrainzapi'
|
|
copyright = '2020, Daniel Tomlinson'
|
|
author = 'Daniel Tomlinson'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = __version__
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.todo',
|
|
'sphinx_click.ext',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.autosectionlabel'
|
|
]
|
|
|
|
# -- Napoleon Settings -----------------------------------------------------
|
|
napoleon_google_docstring = False
|
|
napoleon_numpy_docstring = True
|
|
napoleon_include_init_with_doc = True
|
|
napoleon_include_private_with_doc = True
|
|
napoleon_include_special_with_doc = False
|
|
napoleon_use_admonition_for_examples = False
|
|
napoleon_use_admonition_for_notes = False
|
|
napoleon_use_admonition_for_references = False
|
|
napoleon_use_ivar = True
|
|
napoleon_use_param = True
|
|
napoleon_use_rtype = True
|
|
napoleon_use_keyword = True
|
|
autodoc_member_order = 'bysource'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
html_static_path = ['_static']
|
|
html_context = {'css_files': ['_static/custom.css']}
|
|
html_theme_options = {
|
|
'collapse_navigation': True,
|
|
'display_version': True,
|
|
'prev_next_buttons_location': 'both',
|
|
#'navigation_depth': 3,
|
|
}
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# Enable todo
|
|
todo_include_todos = True
|