Skip to content

fix: correct typos for the Sphinx documentation on GitHub Pages #337

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.

Sign up for GitHub

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

Merged
bast merged 1 commit into from
Apr 22, 2026
Merged

fix: correct typos for the Sphinx documentation on GitHub Pages #337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions content/gh_workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ What do you need to change in the workflow file?
2. **a Jupyter notebook**
1. Change line 16 of `.github/workflows/documentation.yml` from `pip install sphinx sphinx_rtd_theme myst_parser` to `pip install sphinx sphinx_rtd_theme myst_parser myst-nb`.
2. Follow the instructions in [Sphinx-4](#jupyter-exercise) changing paths so that:
1. `flower.md` is `docs/flower.md`
1. `flower.md` is `doc/flower.md`
2. `conf.py` is `doc/conf.py`
3. `index.md` is `doc/index.md`.
3. Commit and push your changes, verify the action has run successfully, and view the built site in your browser.
3. **change the theme**
1. Change line 16 of `.github/workflows/documentation.yml` and add the theme package if necessary.
2. In `docs/config.py` change `html_theme = 'sphinx_rtd_theme'` to the name of your chosen theme.
2. In `doc/conf.py` change `html_theme = 'sphinx_rtd_theme'` to the name of your chosen theme.
3. Commit and push your changes, verify the action has run successfully, and view the built site in your browser.
```
````
Expand Down
Loading