Skip to content

some doc fixes #1468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 7, 2024
Merged

some doc fixes #1468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8d3d35
some doc fixes
zingale Feb 5, 2024
c1b0475
add dollarmath and copybutton
zingale Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ jupyter>=1.0.0
ipywidgets>=7.1.2
numpy>=1.13.3
sphinx-prompt
sphinx-math-dollar
sphinx-copybutton
10 changes: 5 additions & 5 deletions sphinx_docs/rp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
import textwrap

MAIN_HEADER = """
+---------------------------------------+---------------------------------------------------------+--------------------+
| parameter | description | default value |
+=======================================+=========================================================+====================+
+---------------------------------------+---------------------------------------------------------+------------------------------+
| parameter | description | default value |
+=======================================+=========================================================+==============================+
"""

SEPARATOR = """
+---------------------------------------+---------------------------------------------------------+--------------------+
+---------------------------------------+---------------------------------------------------------+------------------------------+
"""

ENTRY = """
| {:37} | {:55} | {:18} |
| {:37} | {:55} | {:28} |
"""

WRAP_LEN = 55
Expand Down
12 changes: 7 additions & 5 deletions sphinx_docs/source/basics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*****************
StarKiller Basics
*****************
*********************
Microphysics Overview
*********************

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

**All quantities are assumed to be in CGS units**, unless otherwise
specified.
.. note::

All quantities are assumed to be in CGS units, unless otherwise
specified.
11 changes: 10 additions & 1 deletion sphinx_docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,14 @@ def get_version():
# ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx_math_dollar',
'sphinx.ext.viewcode',
'sphinxcontrib.bibtex',
'nbsphinx',
'numpydoc',
'IPython.sphinxext.ipython_console_highlighting',
'sphinx.ext.githubpages',
'sphinx_copybutton',
'sphinx-prompt',
'sphinx_rtd_theme',
'breathe']
Expand Down Expand Up @@ -116,7 +118,14 @@ def get_version():


# -- Options for MathJax
mathjax3_config = {'tex': {'macros': {}}}
mathjax3_config = {}

mathjax3_config["tex"] = {
"inlineMath": [['\\(', '\\)']],
"displayMath": [["\\[", "\\]"]],
}

mathjax3_config["tex"]["macros"] = {}

with open('mathsymbols.tex', 'r') as f:
for line in f:
Expand Down
2 changes: 1 addition & 1 deletion sphinx_docs/source/preface.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Preface
*******

Welcome to the StarKiller Microphysics!
Welcome to the AMReX-Astro Microphysics!

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