You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* This tells GitHub to install sphinx and its dependencies to the ubuntu image.
175
+
* **Note**: After you add a new sphinx extension to :code:`pyproject.toml` and to :code:`docs/conf.py`, you'll also need to add the dependency to the list on line 16.
176
+
* **Line 19.** Build Docs
177
+
* This runs :code:`sphinx-build` on the :code:`docs/` directory (in the repo) and creates the :code:`_build/` directory.
178
+
* Line 24. Publish to branch
179
+
* After building the docs, this line tells GitHub to publish the changes to the :code:`gh-pages` branch.
180
+
* **Note**: this needs to be the same branch that GitHub Pages is set to publish with.
181
+
* **Line 26.** Specify directory to publish
182
+
* This informs GitHub Pages where the static HTML documentation (built by :code:`sphinx-build`) is located.
0 commit comments