website: Add Sphinx documentation to website using GitHub Actions #159
+184
−0
Conversation
This file contains 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
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.
Comments skipped due to low confidence (1)
add-sphinx-docs.py:7
- [nitpick] The variable name 'search_flag' is ambiguous. It should be renamed to something more descriptive like 'is_searchbox_visible'.
search_flag = False
|
This is great! I'm testing to see how well copilot works here :) |
powerjg
reviewed
Nov 26, 2024
This commit makes the requested changes to use a dedicated GitHub action to commit and push, and to use a different permalink. This commit also adds in the link to the index page to documentation.yml, which was previously missed and is necessary to have the index page be linked to by the website's sidebar.
This commit changes the path to files to be committed and removes the caching step from sphinx-to-website.yaml. It also makes formatting changes to add-sphinx-docs.py and adds a copyright header.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a workflow file that builds the Sphinx documentation and pushes it to the gem5 website. Currently, it is set to run once a week and build documentation for the stable version of gem5. This PR also includes a Python script that adds frontmatter and makes other alterations to the HTML files generated by Sphinx so they are compatible with the gem5 website.
This was tested using my own forks of the gem5 website and the gem5 repo, so some issues may come up when this workflow is run with the gem5/website repo.
The workflow file also won't work right now, as the current stable version of gem5 doesn't have the
docsfolder needed to build Sphinx. This won't be a problem once v 24.1 comes out, however.