Skip to content

Fix: use mkdocs gh-deploy directly #204

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

Merged
merged 1 commit into from
Jul 30, 2025
Merged

Fix: use mkdocs gh-deploy directly #204

merged 1 commit into from
Jul 30, 2025

Conversation

thekaveman
Copy link
Member

We need to install pems_data before mkdocs can build, since we autogenerate some of the docs from the Python docstrings (#196).

The mhausenblas/mkdocs-deploy-gh-pages action step seems to either ignore or not see that installation.

So make the actual deploy work more like the preview deploy, just install dependencies and use mkdocs gh-deploy directly (which also builds the site).

we need to install pems_data before mkdocs can build

the mhausenblas/mkdocs-deploy-gh-pages action step seems to either
ignore or not see that installation

so make the actual deploy work more like the preview deploy,
just install dependencies and use mkdocs directly
@thekaveman thekaveman self-assigned this Jul 30, 2025
@thekaveman thekaveman added bug Something isn't working documentation Improvements or additions to documentation actions Related to GitHub Actions workflows labels Jul 30, 2025
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

@thekaveman thekaveman marked this pull request as ready for review July 30, 2025 15:51
@thekaveman thekaveman requested a review from a team as a code owner July 30, 2025 15:51
@thekaveman
Copy link
Member Author

thekaveman commented Jul 30, 2025

I ran the Deploy action manually against this branch, and the refactored deploy worked!

https://github.com/compilerla/pems/actions/runs/16627376252

The docs site is live with our changes: https://docs.compiler.la/pems/development/pems_data

@thekaveman thekaveman enabled auto-merge July 30, 2025 15:52
Copy link
Member

@lalver1 lalver1 left a comment

Choose a reason for hiding this comment

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

👍 🎉

@thekaveman thekaveman merged commit ec21e26 into main Jul 30, 2025
11 checks passed
@thekaveman thekaveman deleted the fix/docs-deploy branch July 30, 2025 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions Related to GitHub Actions workflows bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants