doc(quil-py): Publish documentation on GitHub Pages #314
Conversation
This file contains 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
MarquessV
had a problem deploying
to
github-pages
GitHub Actions
Failure
MarquessV
had a problem deploying
to
github-pages
GitHub Actions
Failure
MarquessV
had a problem deploying
to
github-pages
GitHub Actions
Failure
MarquessV
had a problem deploying
to
github-pages
GitHub Actions
Failure
MarquessV
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
GH pages doesn't yet support previewing documentation from a PR, so I had to test the workflow by deploying from this branch. That means the docs are live! As a todo, I'll need to remove this branch from the allowlist for GH pages deployments, and refactor the workflow so that it only triggers on a full release. |
MarquessV
temporarily deployed
to
github-pages
GitHub Actions
Inactive
MarquessV
temporarily deployed
to
github-pages
GitHub Actions
Inactive
MarquessV
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
|
This PR now uses a GitHub action to deploy a preview of the new documentation. On push to main, it will update the main GitHub pages site. |
Shadow53
reviewed
Dec 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use pdoc and GitHub pages to build and deploy a live site with our
quil-pytype hints as documentation.Due to some issue between pdoc, pyo3, and type hints, nested submodules don't render. This may be related to this issue.