Update site github action workflow #612
Merged
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.
Closes #610
This pull request introduces a new workflow for deploying documentation and includes a script to generate HTML documentation from the
README.md
file. The most important changes are the addition of a GitHub Actions workflow, the creation of a Python script for generating documentation, and the inclusion of necessary dependencies.It should also be added to the GitHub Pages setting to use the
gh-pages
branch as the source.Documentation Deployment:
.github/workflows/update-site.yml
: Added a GitHub Actions workflow to deploy documentation to GitHub Pages on pushes to themain
branch that affect theREADME.md
file. This workflow checks out the repository, sets up Python, installs dependencies, generates documentation, and deploys it to GitHub Pages.Documentation Generation:
docs/src/generate_docs.py
: Added a Python script that converts theREADME.md
file to HTML usingpycmarkgfm
andBeautifulSoup
, and structures the HTML for deployment.Dependencies:
docs/src/requirements.txt
: Addedpycmarkgfm
andbeautifulsoup4
as dependencies for the documentation generation script.