--- a +++ b/docs/source/conf.py @@ -0,0 +1,113 @@ +# 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("../..")) + + +def get_version(): + init_py_path = os.path.join( + os.path.abspath(os.path.dirname(__file__)), "../../dosma", "__init__.py" + ) + init_py = open(init_py_path, "r").readlines() + version_line = [l.strip() for l in init_py if l.startswith("__version__")][0] # noqa: E741 + version = version_line.split("=")[-1].strip().strip("'\"") + return version + + +# -- Project information ----------------------------------------------------- + +project = "dosma" +copyright = "2019-2021, Arjun Desai" +author = "Arjun Desai" + +# The full version, including alpha/beta/rc tags +# release = setup.get_version(ignore_nightly=True) +release = get_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.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.mathjax", + "sphinx.ext.ifconfig", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", + "sphinxcontrib.bibtex", + "sphinx_rtd_theme", + "sphinx.ext.githubpages", + "m2r2", +] +autosummary_generate = True +autosummary_imported_members = True + +# Bibtex files +bibtex_bibfiles = ["references.bib"] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# -- 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 = 'alabaster' +# html_theme = 'bootstrap' +# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() +html_theme = "sphinx_rtd_theme" + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "DOSMAdoc" + +# 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"] + +# Intersphinx mappings +intersphinx_mapping = {"numpy": ("https://numpy.org/doc/stable/", None)} + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = {"navigation_depth": 2} + +# Source Files +source_suffix = [".rst", ".md"] + +# Documentation to include +todo_include_todos = True +napoleon_use_ivar = True +napoleon_google_docstring = True +html_show_sourcelink = False