diff --git a/docs/README.md b/docs/README.md index edd25eadaf4..65f3cb66308 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,6 +15,7 @@ Updating docs can be confusing. Here are the basic setups. 1. Build the docs, from the inside of the docs folder. * **Requires** sphinx: `pip install sphinx` * **Requires** nbsphinx: `pip install nbsphinx` (this will render the images from jupyter in the docs) + * **Requires** sphinx-copybutton: `pip install sphinx-copybutton` (this will enable a copy option at the top of the code written in the docs) * `make html` 1. Commit the changes. If there are new files, you will have to explicit add them. * `git commit -am "Updating docs."` @@ -32,5 +33,5 @@ From this point, you will need to find someone that has access to readthedocs. C ### Helpful Sphnix tips * Build html from docs: * `make html` -* Autogenerate / update sphninx from docstrings (replace your name as the author: +* Autogenerate / update sphninx from docstrings (replace your name as the author): * `sphinx-apidoc -A "Jackie Kazil" -F -o docs mesa/` \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 24dfa07b786..84d0f087eab 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,6 +47,7 @@ "sphinx.ext.viewcode", "sphinx.ext.napoleon", # for google style docstrings "myst_nb", # For Markdown and Jupyter notebooks + "sphinx_copybutton" # For copying the code in the documentation ] # Add any paths that contain templates here, relative to this directory.