forked from rai-opensource/spatialmath-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconf.py
More file actions
161 lines (140 loc) · 5.44 KB
/
conf.py
File metadata and controls
161 lines (140 loc) · 5.44 KB
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# spatialmath
# 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('.'))
# sys.path.insert(0, os.path.abspath('..'))
# -- Project information -----------------------------------------------------
project = 'Spatial Maths package'
copyright = '2022, Peter Corke'
author = 'Peter Corke'
version = '0.12'
print(__file__)
# The full version, including alpha/beta/rc tags
with open('../../RELEASE', encoding='utf-8') as f:
release = f.read()
# -- 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.todo',
'sphinx.ext.viewcode',
'sphinx.ext.mathjax',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
'sphinx.ext.inheritance_diagram',
'sphinx_autorun',
]
#'sphinx-prompt',
#'recommonmark',
#'sphinx.ext.autosummary',
#'sphinx_markdown_tables',
#
# inheritance_node_attrs = dict(style='rounded,filled', fillcolor='lightblue')
inheritance_node_attrs = dict(style='rounded')
autosummary_generate = True
autodoc_member_order = 'groupwise'
# bysource
# 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 = ['test_*']
add_module_names = False
# -- 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 = 'alabaster'
#html_theme = 'pyramid'
#html_theme = 'sphinxdoc'
html_theme_options = {
#'github_user': 'petercorke',
#'github_repo': 'spatialmath-python',
#'logo_name': False,
'logo_only': False,
#'description': 'Spatial maths and geometry for Python',
'display_version': True,
'prev_next_buttons_location': 'both',
'analytics_id': 'G-11Q6WJM565',
}
html_logo = '../figs/CartesianSnakes_LogoW.png'
html_favicon = 'favicon.ico'
# 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']
# autodoc_mock_imports = ["numpy", "scipy"]
html_last_updated_fmt = '%d-%b-%Y'
# extensions = ['rst2pdf.pdfbuilder']
# pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]
latex_engine = 'xelatex'
# maybe need to set graphics path in here somewhere
# \graphicspath{{figures/}{../figures/}{C:/Users/me/Documents/project/figures/}}
# https://stackoverflow.com/questions/63452024/how-to-include-image-files-in-sphinx-latex-pdf-files
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
'papersize': 'a4paper',
#'releasename':" ",
# Sonny, Lenny, Glenn, Conny, Rejne, Bjarne and Bjornstrup
# 'fncychap': '\\usepackage[Lenny]{fncychap}',
'fncychap': '\\usepackage{fncychap}',
}
# see https://stackoverflow.com/questions/9728292/creating-latex-math-macros-within-sphinx
mathjax_config = {
'TeX': {
'Macros': {
# RVC Math notation
# - not possible to do the if/then/else approach
# - subset only
"presup": [r"\,{}^{\scriptscriptstyle #1}\!", 1],
# groups
"SE": [r"\mathbf{SE}(#1)", 1],
"SO": [r"\mathbf{SO}(#1)", 1],
"se": [r"\mathbf{se}(#1)", 1],
"so": [r"\mathbf{so}(#1)", 1],
# vectors
"vec": [r"\boldsymbol{#1}", 1],
"dvec": [r"\dot{\boldsymbol{#1}}", 1],
"ddvec": [r"\ddot{\boldsymbol{#1}}", 1],
"fvec": [r"\presup{#1}\boldsymbol{#2}", 2],
"fdvec": [r"\presup{#1}\dot{\boldsymbol{#2}}", 2],
"fddvec": [r"\presup{#1}\ddot{\boldsymbol{#2}}", 2],
"norm": [r"\Vert #1 \Vert", 1],
# matrices
"mat": [r"\mathbf{#1}", 1],
"dmat": [r"\dot{\mathbf{#1}}", 1],
"fmat": [r"\presup{#1}\mathbf{#2}", 2],
# skew matrices
"sk": [r"\left[#1\right]", 1],
"skx": [r"\left[#1\right]_{\times}", 1],
"vex": [r"\vee\left( #1\right)", 1],
"vexx": [r"\vee_{\times}\left( #1\right)", 1],
# quaternions
"q": r"\mathring{q}",
"fq": [r"\presup{#1}\mathring{q}", 1],
}
}
}
autorun_languages = {}
autorun_languages['pycon_output_encoding'] = 'UTF-8'
autorun_languages['pycon_input_encoding'] = 'UTF-8'
autorun_languages['pycon_runfirst'] = """
from spatialmath import SE3
SE3._color = False
import numpy as np
np.set_printoptions(precision=4, suppress=True)
"""