update readme with notes on updating theme

This commit is contained in:
Lucy Cifferello
2021-04-14 15:43:55 -06:00
parent 886433a9eb
commit 68f76796d6

View File

@@ -46,4 +46,13 @@ Click on the "Pull requests" tab in the top navbar. Select the green "New pull r
## Helpful Resources
- [Lists in RST](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html)
- [Lists in RST](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html)
## Updating theme
To update Sphinx Book Theme:
- `pip uninstall sphinx-book-theme` (needed to properly propagate new changes for some undetermined reason)
- `pip install sphinx-book-theme==<tag_version>` || `pip install git+https://github.com/executablebooks/sphinx-book-theme.git@<branch_name>` eg. `pip install sphinx-book-theme==0.0.42`
To deploy theme update:
- Build and publish according to production release process