https://github.com/jiwoncpark/baobab
Raw File
Tip revision: e1aa39bb8cd56f28cca3de959ee5652da1f2a72d authored by Sebastian Wagner-Carena on 30 November 2020, 20:27:11 UTC
starting to implement substructure
Tip revision: e1aa39b
conf.py
# 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
cwd = os.getcwd()
parent = os.path.dirname(cwd)
sys.path.insert(0, parent)
import baobab

# -- Project information -----------------------------------------------------

project = 'pybaobab'
copyright = '2019, Ji Won Park'
author = 'Ji Won Park'

# The full version, including alpha/beta/rc tags
release = '0.1'


# -- 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.
import sphinx_rtd_theme

extensions = ['sphinx_rtd_theme',
'sphinx.ext.autodoc', 
'sphinx.ext.coverage', 
'sphinx.ext.napoleon',
'sphinx.ext.mathjax',
'sphinx.ext.todo',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames
source_suffix = '.rst'

# 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']

# Default sphinx version looks for 'content' so explicitly assign the master document
master_doc = 'index'

# -- 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_static_path = ['_static']

html_math_renderer = 'mathjax'
back to top