Skip to content

Commit 0ad950a

Browse files
authored
some doc fixes (AMReX-Astro#1468)
this adds dollar math and copybutton also removes the vestiges of "starkiller"
1 parent 49fba8d commit 0ad950a

File tree

5 files changed

+25
-12
lines changed

5 files changed

+25
-12
lines changed

requirements.txt

+2
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ jupyter>=1.0.0
99
ipywidgets>=7.1.2
1010
numpy>=1.13.3
1111
sphinx-prompt
12+
sphinx-math-dollar
13+
sphinx-copybutton

sphinx_docs/rp.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
import textwrap
66

77
MAIN_HEADER = """
8-
+---------------------------------------+---------------------------------------------------------+--------------------+
9-
| parameter | description | default value |
10-
+=======================================+=========================================================+====================+
8+
+---------------------------------------+---------------------------------------------------------+------------------------------+
9+
| parameter | description | default value |
10+
+=======================================+=========================================================+==============================+
1111
"""
1212

1313
SEPARATOR = """
14-
+---------------------------------------+---------------------------------------------------------+--------------------+
14+
+---------------------------------------+---------------------------------------------------------+------------------------------+
1515
"""
1616

1717
ENTRY = """
18-
| {:37} | {:55} | {:18} |
18+
| {:37} | {:55} | {:28} |
1919
"""
2020

2121
WRAP_LEN = 55

sphinx_docs/source/basics.rst

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*****************
2-
StarKiller Basics
3-
*****************
1+
*********************
2+
Microphysics Overview
3+
*********************
44

55
Getting Started (Standalone)
66
============================
@@ -133,5 +133,7 @@ solvers (ODE integration for the network and Newton-Raphson root
133133
finding for the EOS) is separated from the specific implementations of
134134
the microphysics.
135135

136-
**All quantities are assumed to be in CGS units**, unless otherwise
137-
specified.
136+
.. note::
137+
138+
All quantities are assumed to be in CGS units, unless otherwise
139+
specified.

sphinx_docs/source/conf.py

+10-1
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,14 @@ def get_version():
4848
# ones.
4949
extensions = ['sphinx.ext.autodoc',
5050
'sphinx.ext.mathjax',
51+
'sphinx_math_dollar',
5152
'sphinx.ext.viewcode',
5253
'sphinxcontrib.bibtex',
5354
'nbsphinx',
5455
'numpydoc',
5556
'IPython.sphinxext.ipython_console_highlighting',
5657
'sphinx.ext.githubpages',
58+
'sphinx_copybutton',
5759
'sphinx-prompt',
5860
'sphinx_rtd_theme',
5961
'breathe']
@@ -116,7 +118,14 @@ def get_version():
116118

117119

118120
# -- Options for MathJax
119-
mathjax3_config = {'tex': {'macros': {}}}
121+
mathjax3_config = {}
122+
123+
mathjax3_config["tex"] = {
124+
"inlineMath": [['\\(', '\\)']],
125+
"displayMath": [["\\[", "\\]"]],
126+
}
127+
128+
mathjax3_config["tex"]["macros"] = {}
120129

121130
with open('mathsymbols.tex', 'r') as f:
122131
for line in f:

sphinx_docs/source/preface.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Preface
33
*******
44

5-
Welcome to the StarKiller Microphysics!
5+
Welcome to the AMReX-Astro Microphysics!
66

77
In this User’s Guide we describe the microphysics modules designed to
88
enable simulations of stellar explosions.

0 commit comments

Comments
 (0)