Add GitHub Action to test mkdocs documentation build #7658
Closed
+92
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Addresses issue plotly#7627 - Workflow triggers on push/PR to live-docs branch - Uses uv package manager for Python dependencies - Builds examples, reference docs, and mkdocs site - Uploads build artifacts for review - Includes strict mode for mkdocs to catch errors
Author
|
@LiamConnors @camdecoster can you please review the pr once and let me know if any changes are required |
Contributor
|
Hello @kunal-10-cloud! Thanks for the PR. Before we add this action, some changes will need to be made to the build process. This would change the requirements for the action, so we won't be able to merge this for now. Once we get the build process dialed in, we'd be happy to have your help adding this action. I'm going to close the PR, but we can reopen it once we get to a point where we're ready for the action. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview:
pushandpull_requestto thelive-docsbranchuvpackage manager to install dependencies (matching the Makefile)make examples)make reference)--strictmode to catch warnings/errorsLink to issue:
Addresses #7627
Checklist:
draftlogs/dist/folder