Skip to content
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.

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

Update site github action workflow #612

Merged
merged 2 commits into from
Nov 18, 2024
Merged

Conversation

arash77
Copy link
Contributor

@arash77 arash77 commented Nov 18, 2024

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 the main branch that affect the README.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 the README.md file to HTML using pycmarkgfm and BeautifulSoup, and structures the HTML for deployment.

Dependencies:

@bgruening bgruening merged commit 55ad059 into bgruening:main Nov 18, 2024
1 of 2 checks passed
@arash77 arash77 deleted the update-site branch November 18, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

repair the website
2 participants