Skip to content

add documentation action and fix make html #53

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

Merged
merged 2 commits into from
Apr 15, 2025
Merged

add documentation action and fix make html #53

merged 2 commits into from
Apr 15, 2025

Conversation

yemeen
Copy link
Member

@yemeen yemeen commented Apr 8, 2025

lets github automatically compile docs and commit them

Description

#46 (comment)
downloads python and then runs make html and commits

Motivation and Context

allows users to just commit code

How has this been tested?

tested with act -W .github/workflows/docs.yml push

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • [ x] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • My code follows the code style of this project. (make clean)
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly. (make html)
  • I have incremented the version number in the pyproject.toml file.
  • I have added tests to cover my changes.
  • All new and existing tests passed. (make tests)

@yemeen yemeen requested a review from lizliz as a code owner April 8, 2025 21:23
@yemeen yemeen linked an issue Apr 8, 2025 that may be closed by this pull request
Copy link
Contributor

@lizliz lizliz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@lizliz lizliz merged commit 0010edd into main Apr 15, 2025
2 checks passed
@yemeen yemeen deleted the docs-action branch April 15, 2025 21:17
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.

Documentation autocreation
2 participants