Skip to content

Generate docs#3

Draft
amundmr wants to merge 3 commits into
mainfrom
2-generate-docs
Draft

Generate docs#3
amundmr wants to merge 3 commits into
mainfrom
2-generate-docs

Conversation

@amundmr

@amundmr amundmr commented Dec 20, 2023

Copy link
Copy Markdown
Owner

Documentation set up to be auto-built using pdoc and deployed to github pages using github actions.
This does not require a docs/ folder yet as there are no customizations to the pdoc build. Everything is to be documented in the code using docstrings.

Resolves #2

Todo:

  • Set up GitHub actions workflow to auto-build and deploy the pdoc documentation to GitHub pages
  • Add docstrings to everything

@amundmr amundmr linked an issue Dec 20, 2023 that may be closed by this pull request
@amundmr amundmr changed the title 2 Generate docs Generate docs Dec 20, 2023
@amundmr amundmr self-assigned this Dec 20, 2023
@amundmr amundmr added the documentation Improvements or additions to documentation label Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Generate documentation

1 participant