DOC: use pypandoc-binary while building documentation #41
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
Note: the idea is to be able to work with new self hosted runners without having to install pandoc manually everytime. Here, we leverage pypandoc-binary to use pandoc without installing it before running the documentation. A sphinx even hook is used to update the PATH environment variable if needed.
github-actions
bot
added
documentation
Samuelopez-ansys
approved these changes
Feb 21, 2024
Samuelopez-ansys
approved these changes
Feb 21, 2024
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.
The idea of this PR is to be able to build the documentation on any self-hosted runner (or event locally) without having to install
pandocmanually (error prone). Here, we leveragepypandoc-binaryto usepandocwithout installing it before running the documentation. A sphinx even hook is used to update thePATHenvironment variable if needed.