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

Sphinx docs workflow #21

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Sphinx docs workflow #21

merged 2 commits into from
Sep 25, 2024

Conversation

paulmaxus
Copy link
Collaborator

Added sphinx documentation with basic design.

docs are auto-built on specified modules in /src/framework/processing/py/

  • props
  • extraction helpers
  • port helpers
  • validation
  • platforms

gh actions workflow builds docs and deploys them to gh-pages-docs branch

closes #20

@paulmaxus paulmaxus requested a review from trbKnl September 25, 2024 12:10
@paulmaxus paulmaxus marked this pull request as ready for review September 25, 2024 12:12
Copy link
Collaborator

@trbKnl trbKnl left a comment

Choose a reason for hiding this comment

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

Nog even squashen? maakt straks de rebase met upstream ook makkelijker!

Maar top ziet er goed uit! Mergen maar :)

@paulmaxus paulmaxus merged commit 56b7a44 into master Sep 25, 2024
2 checks passed
@trbKnl trbKnl deleted the sphinx-docs-workflow branch November 13, 2024 10:34
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.

Add sphinx documentation and deploy to pages
2 participants