-
Notifications
You must be signed in to change notification settings - Fork 37
/
config.yaml
48 lines (38 loc) · 1.67 KB
/
config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# This file contain general settings fot the creation of sphinx conf.py
# docstring is a special keys, inserted at the top of the file,
# all others are output as <key> = <val>
docstring: |4
a default sphinx configuration file
This file is execfile()d by Sphinx,
with the current directory set to its containing dir
.. seealso::
http://www.sphinx-doc.org/en/master/usage/configuration.html
needs_sphinx: "1.6" # sphinx.ext.imgconverter requires 1.6
master_doc: "index"
source_suffix: [".rst"]
# Exclude build directory and Jupyter backup files:
exclude_patterns: ["_build", "build", "**.ipynb_checkpoints"]
extensions: [
'ipypublish.sphinx.notebook', # includes nboutput and nbinput directives
'ipypublish.sphinx.gls', # includes gls role
'sphinx.ext.mathjax', # convert latex math to html
'sphinxcontrib.bibtex', # allows for :cite: and .. bibligraphy::
'sphinx.ext.todo', # allows for .. todo:: directive
]
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos: false
# html_theme: 'alabaster'
numfig: true # allow elements to be numbered
numfig_secnum_depth: 2
numfig_format: {'section': 'Section %s',
'figure': 'Fig. %s',
'table': 'Table %s',
'code-block': 'Code Block %s'}
math_numfig: true # allow equations to be numbered
math_eqref_format: "eq.{number}" # TODO this isn't working
linkcheck_ignore: [r'http://localhost:\d+/']
# # List of arguments to be passed to the kernel that executes the notebooks:
# nbsphinx_execute_arguments: [
# "--InlineBackend.figure_formats={'svg', 'pdf'}",
# "--InlineBackend.rc={'figure.dpi': 96}",
# ]