Add integration with the postgkyl 2.0 repository - #89
Open
Maxwell-Rosen wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a postgkyl section to the documentation website. The goal is to have the documentation automatically built from the postgkyl repository. All examples are tested with CI on both the postgkyl and docs sides. Postgkyl is cloned and built on the website, data is generated, and all plots are made on the fly to avoid storing data files inside git. This is built against postgkeyll on branch main, so we must merge postgkeyll 2.0 first. Codex also fixed a few typos throughout the website because I think they were causing build errors.
Here are some screenshots of a local build:
Installation is just the readme
Several pages are provided with examples from postgkyl/examples
Documentation for every python function and CLI command, automatically generated from docstrings
