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

[WIP] Deploy docs from GitHub Actions #5360

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Conversation

banesullivan
Copy link
Member

@banesullivan banesullivan commented Dec 18, 2023

Work to automate the documentation deployment for #5344

To do:

  • Update .github/workflows/preview_pull_request.yml
  • Fix the 404 page
  • Script the additional version redirect links on releases
  • Script the generation of new sites on release
  • Fix issue where clicking on any link redirects to "stable" when viewing previous versions

@github-actions github-actions bot added documentation Anything related to the documentation/website maintenance Low-impact maintenance activity labels Dec 18, 2023
Comment on lines +16 to +18

This is a test message to see if the deployment is working!

Copy link
Member Author

Choose a reason for hiding this comment

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

Simply to test if the built docs are indeed being deployed. Will remove.

@banesullivan banesullivan changed the title [WIP] Deploy from GitHub Actions [WIP] Deploy docs from GitHub Actions Dec 18, 2023
Copy link

codecov bot commented Dec 18, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.99%. Comparing base (5bb9ed0) to head (76be13b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5360   +/-   ##
=======================================
  Coverage   96.99%   96.99%           
=======================================
  Files         141      141           
  Lines       24666    24666           
=======================================
  Hits        23925    23925           
  Misses        741      741           

Comment on lines +82 to +88
- name: Cache Sphinx build directory
uses: actions/cache@v3
if: env.USE_CACHE == 'true' && !startsWith(github.ref, 'refs/heads/release/') && !startsWith(github.ref, 'refs/tags/v')
with:
path: doc/_build/
key: doc-examples-${{ hashFiles('pyvista/_version.py') }}

Copy link
Member Author

Choose a reason for hiding this comment

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

I want to reflect on whether or not we actually want to do this

@github-actions github-actions bot temporarily deployed to production December 18, 2023 07:23 Inactive
@github-actions github-actions bot temporarily deployed to production December 19, 2023 00:26 Inactive
@github-actions github-actions bot temporarily deployed to production December 23, 2023 22:12 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website maintenance Low-impact maintenance activity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants