Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a copy option at the top of the code written in the docs #2628

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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."`
Expand All @@ -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/`
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading