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

Upload docs build in CI #314

Merged
merged 2 commits into from
Jul 10, 2023
Merged

Upload docs build in CI #314

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ea9620
Upload docs build in CI
Eric-Arellano Jul 10, 2023
d9bdd18
Update .github/workflows/docs.yml
Eric-Arellano Jul 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ jobs:
shell: bash
run: |
tox -edocs
- name: Upload docs artifact
if: always()
Copy link
Collaborator

Choose a reason for hiding this comment

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

Any reason you like the if statement here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Like, where it is visually located? I copied the style you used from the Deploy docs job below it

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can just remove the if statement here

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We've found it useful to set if: always. When the Sphinx doc build fails due to warnings (e.g. bad indentation), it still produces the docs artifact. It is useful to be able to look at those docs to understand Sphinx's notoriously cryptic error messages.

uses: actions/upload-artifact@v3
Eric-Arellano marked this conversation as resolved.
Show resolved Hide resolved
with:
name: html_docs
path: ./docs/_build/html
- name: Deploy docs
if: ${{ github.ref == 'refs/heads/stable/0.2' }}
uses: peaceiris/actions-gh-pages@v3
Expand Down