|
a |
|
b/docs/conf.py |
|
|
1 |
# Configuration file for the Sphinx documentation builder. |
|
|
2 |
# |
|
|
3 |
# This file only contains a selection of the most common options. For a full |
|
|
4 |
# list see the documentation: |
|
|
5 |
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
|
|
6 |
|
|
|
7 |
# -- Path setup -------------------------------------------------------------- |
|
|
8 |
|
|
|
9 |
# If extensions (or modules to document with autodoc) are in another directory, |
|
|
10 |
# add these directories to sys.path here. If the directory is relative to the |
|
|
11 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
|
|
12 |
# |
|
|
13 |
# import os |
|
|
14 |
# import sys |
|
|
15 |
# sys.path.insert(0, os.path.abspath('.')) |
|
|
16 |
import sphinx_rtd_theme |
|
|
17 |
|
|
|
18 |
|
|
|
19 |
# -- Project information ----------------------------------------------------- |
|
|
20 |
|
|
|
21 |
|
|
|
22 |
project = 'HippUnfold Documentation' |
|
|
23 |
copyright = '2020, Jordan DeKraker and Ali R. Khan' |
|
|
24 |
author = 'HippUnfold Development Team' |
|
|
25 |
|
|
|
26 |
|
|
|
27 |
# -- General configuration --------------------------------------------------- |
|
|
28 |
|
|
|
29 |
# Add any Sphinx extension module names here, as strings. They can be |
|
|
30 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
|
|
31 |
# ones. |
|
|
32 |
extensions = [ |
|
|
33 |
"sphinx_rtd_theme", |
|
|
34 |
"sphinxarg.ext", |
|
|
35 |
"myst_parser", |
|
|
36 |
"sphinxcontrib.asciinema", |
|
|
37 |
] |
|
|
38 |
|
|
|
39 |
|
|
|
40 |
# Add any paths that contain templates here, relative to this directory. |
|
|
41 |
templates_path = ['_templates'] |
|
|
42 |
|
|
|
43 |
# List of patterns, relative to source directory, that match files and |
|
|
44 |
# directories to ignore when looking for source files. |
|
|
45 |
# This pattern also affects html_static_path and html_extra_path. |
|
|
46 |
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
|
|
47 |
|
|
|
48 |
myst_enable_extensions = ['html_image','dollarmath','amsmath'] |
|
|
49 |
myst_heading_anchors = 3 |
|
|
50 |
|
|
|
51 |
master_doc = 'index' |
|
|
52 |
|
|
|
53 |
|
|
|
54 |
# -- Options for HTML output ------------------------------------------------- |
|
|
55 |
|
|
|
56 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
|
57 |
# a list of builtin themes. |
|
|
58 |
# |
|
|
59 |
html_theme = "sphinx_rtd_theme" |
|
|
60 |
|
|
|
61 |
# Add any paths that contain custom static files (such as style sheets) here, |
|
|
62 |
# relative to this directory. They are copied after the builtin static files, |
|
|
63 |
# so a file named "default.css" will overwrite the builtin "default.css". |
|
|
64 |
html_static_path = ['_static'] |
|
|
65 |
|
|
|
66 |
|
|
|
67 |
|
|
|
68 |
|