add instructions on building the docs to the readme with requirements

arfc · Feb 23, 2024 · 11dc92f · 11dc92f
1 parent 4d09703
commit 11dc92f
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 8 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -87,7 +87,7 @@
     'pandas': ('https://pandas.pydata.org/docs/', None),
     'numpy': ('https://numpy.org/doc/stable/', None),
     'astropy': ('https://docs.astropy.org/en/stable/', None),
-    'cyclus': ('https://fuelcycle.org/', None)
+    'cyclus': ('https://fuelcycle.org/', None),
 }
 
 

diff --git a/docs/docs_README.md b/docs/docs_README.md
diff --git a/docs/index.md b/docs/index.md
@@ -26,4 +26,30 @@ transition_plots_doc
 
 - {ref}`genindex`
 - {ref}`modindex`
-- {ref}`search`
+- {ref}`search`
+
+
+# Building the Docs
+To compile the documentation, make sure you have all the requirements
+installed, then run `make html` from the top level of the repository.
+
+```{warning}
+The docs are still in their nascent stage. If you find a
+problem, please open an issue on
+[github](https://github.com/arfc/transition-scenarios/issues).
+```
+
+## Docs Requirements
+* sphinx
+* myst_parser
+* sphinx.ext.napoleon
+* sphinx.ext.duration
+* sphinx.ext.autosectionlabel
+* sphinx.ext.autodoc
+* sphinx.ext.autosummary
+* sphinx.ext.intersphinx
+* sphinx.ext.viewcode
+* sphinx.ext.mathjax
+* sphinx.ext.coverage
+* nbsphinx
+* sphinxcontrib.mermaid