diff --git a/docs/conf.py b/docs/conf.py index 11737b37..3ddf1988 100644 --- 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 deleted file mode 100644 index be1d1e3d..00000000 --- a/docs/docs_README.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -Requirements -============ - m2r2 diff --git a/docs/index.md b/docs/index.md index e376a3a2..0232e4c1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -26,4 +26,30 @@ transition_plots_doc - {ref}`genindex` - {ref}`modindex` -- {ref}`search` \ No newline at end of file +- {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 \ No newline at end of file