[📝] Autogenerate Documentation #184
Conversation
|
Seems to be missing the first argument in every function - |
|
The returns is also formatted differently |
|
My bad I forgot to tell it to use Google-style docstrings (made a new commit, looks like this since it'll take a few minutes to build/deploy:) |
| jobs: | ||
| # Build the documentation and upload the static HTML files as an artifact. | ||
| build: | ||
| runs-on: windows-latest |
There was a problem hiding this comment.
Generally, we would prefer jobs run on ubuntu-latest unless you absolutely need Windows.
There was a problem hiding this comment.
I used ubuntu-latest but I couldn't figure out this error
terminate called after throwing an instance of 'std::runtime_error'
what(): random_device could not be read
/home/runner/work/_temp/aa96a6f4-a556-45f5-a8b1-05d0770bba35.sh: line 1: 1882 Aborted (core dumped) poetry run python -m pdoc ./PyHa -o docs/
Error: Process completed with exit code 134.
I suspect it has something to do with this issue but I figured generating docs worked on my machine (windows) so it would work on the action
There was a problem hiding this comment.
Please add an issue to PyHa referencing that issue then resolve this conversation.
- Remove np-generate-docs - If statement in action - Move pdoc to dev dependencies - Badge in README - Edit links
| deploy: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| if: github.ref == 'refs/heads/main' |
There was a problem hiding this comment.
This and line 9 are redundant!
| deploy: | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| if: github.ref == 'refs/heads/main' | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - id: deployment | ||
| uses: actions/deploy-pages@v4 |
There was a problem hiding this comment.
This repo already has a GitHub Pages deployment! @sprestrelski @Sean1572 please reconcile this!
There was a problem hiding this comment.
If you modify pyproject.toml, you need to update poetry.lock using poetry lock!
I added pdoc in a GitHub Action to automatically generate documentation when the main branch changes. Here's a preview on my fork.
NOTE:
This will require enabling GitHub Pages in settings so the documentation will automatically be deployed (replace the test branch with "main" instead, example of settings shown below).