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.

Sign up for GitHub

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

Jump to bottom

Pdoc3 - auto validation #60

Merged
merged 7 commits into from Feb 19, 2022
Merged

Pdoc3 - auto validation #60

merged 7 commits into from Feb 19, 2022

Conversation

thomasyu888
Copy link
Member

@thomasyu888 thomasyu888 commented Feb 18, 2022 •
edited

Add auto documentation - will improve over time. This Github action does several steps whenever there is a push to the develop branch:

  • It uses pdoc3 and creates the documentation
  • Pushes the changes to thegh-pages branch
  • The gh-pages branch has a index.html

@thomasyu888 thomasyu888 changed the title Pdoc3 Pdoc3 - auto validation Feb 18, 2022
@thomasyu888 thomasyu888 merged commit d665ad4 into develop Feb 19, 2022
@thomasyu888 thomasyu888 deleted the pdoc3 branch February 19, 2022 00:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hhunterzinck hhunterzinck hhunterzinck approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@thomasyu888 @hhunterzinck