|
- # 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
- import sphinx_rtd_theme
-
- # -- 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('../'))
-
-
- # -- Project information -----------------------------------------------------
-
- project = 'ARES'
- copyright = '2020, ARES contributors'
- author = 'ARES contributors'
-
- # The short X.Y version
- version = '0.1'
-
- # The full version, including alpha/beta/rc tags
- release = '0.1'
-
- master_doc = 'index'
-
-
- # -- 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.todo',
- 'recommonmark',
- ]
-
- # Add any paths that contain templates here, relative to this directory.
- templates_path = ['_templates']
-
- # The language for content autogenerated by Sphinx. Refer to documentation
- # for a list of supported languages.
- #
- # This is also used if you do content translation via gettext catalogs.
- # Usually you set "language" from the command line for these cases.
- language = 'en'
-
- # 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 = ['_build', 'Thumbs.db', '.DS_Store']
-
-
- # -- 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'
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
- # 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_static_path = ['_static']
-
-
- # -- Extension configuration -------------------------------------------------
-
- # -- Options for todo extension ----------------------------------------------
-
- # If true, `todo` and `todoList` produce output, else they produce nothing.
- todo_include_todos = True
-
- def skip(app, what, name, obj, would_skip, options):
- if name == '__init__':
- return False
- return would_skip
-
- def setup(app):
- app.connect('autodoc-skip-member', skip)
|