Add GitHub Workflow to deploy documentation to Pages #56
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
November 14, 2024 15:43
The configuration file was last generated in 2012. This removes some configuration options that do not appear any more when running sphinx-quickstart [1]. This also adds "make.bat" for Windows users. The extension folder is also removed as "math_dollar.py" appears to be unused. [1] https://www.sphinx-doc.org/en/master/usage/quickstart.html
The workflow is lightly adapted from the one suggested in theSphinx documentation [1]. It builds and pushes the website to the "gh-pages" branch which can then be published from the repository's settings [2]. A push event to "master" triggers the workflow. [3] [1] https://www.sphinx-doc.org/en/master/tutorial/deploying.html#id5 [2] https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch [3] https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#push
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
Here's a possible workflow which builds the website and pushes it to the
gh-pagesbranch.This branch can then be published through Pages, which, I believe is the system used to serve the website.
Please note I did remove a number of configuration options in
conf.py(in particular some linked to latex, texinfo and man output).If this is unwanted, let me know so I revert this change.
Closes #54