Skip to content

Commit

Permalink
index, sphix config
Browse files Browse the repository at this point in the history
  • Loading branch information
AstroBarker committed Sep 26, 2024
1 parent 6c498e2 commit b31a63f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
13 changes: 8 additions & 5 deletions doc/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Phoebus'
copyright = '2024, Triad National Security'
author = 'The Phoebus Team'
release = '1.0.0'
project = "Phoebus"
copyright = "2024, Triad National Security"
author = "The Phoebus Team"
release = "1.0.0"

# -- 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_multiversion"]
extensions = ["sphinx_multiversion", "sphinx.ext.todo", "sphinx_copybutton"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -41,3 +41,6 @@

# configuration for sphinx_multiversion
smv_remote_whitelist = r"^(origin)$"

# Display todos by setting to True
todo_include_todos = True
8 changes: 5 additions & 3 deletions doc/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ Key Features
^^^^^^^^^^^^^

* Finite volume GRMHD
* Neutrino transport
* GR...
* fill out
* Neutrino transport with Monte Carlo and moment methods
* Analytic and tabulated spacetimes
* Monopolar general relativistic gravity for core-collapse supernovae
* Lagrangian tracer particles
* Support for arbitrary equations of state

.. note::

Expand Down

0 comments on commit b31a63f

Please sign in to comment.