From b31a63f57fa90006285c39e5a83e23e6b94cb2e6 Mon Sep 17 00:00:00 2001 From: Brandon Barker Date: Thu, 26 Sep 2024 19:56:49 -0400 Subject: [PATCH] index, sphix config --- doc/sphinx/conf.py | 13 ++++++++----- doc/sphinx/index.rst | 8 +++++--- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py index 4d46870d..b40c4d7a 100644 --- a/doc/sphinx/conf.py +++ b/doc/sphinx/conf.py @@ -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"] @@ -41,3 +41,6 @@ # configuration for sphinx_multiversion smv_remote_whitelist = r"^(origin)$" + +# Display todos by setting to True +todo_include_todos = True diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst index d4550e87..3456b78f 100644 --- a/doc/sphinx/index.rst +++ b/doc/sphinx/index.rst @@ -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::