Docs website #58
Merged
Docs website #58
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
…e cases with missing group
…ke type hints py38 compat.
Closed
4 tasks
rmfranken
requested changes
Jun 8, 2023
gimie/cli.py
Outdated
There was a problem hiding this comment.
This renders a bit strange, you get a header "gimie" and then the text "Command line group".
After that, it shows two code-snippets with the exact same code, with no information on what this actually means/does. I think it could be ommited for clarity, or explained.
There was a problem hiding this comment.
Not very worth it to spend a lot of time, so very optional thing to do if someone feels bored.
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.
This PR adds a documentation website. The website is built with sphinx and deployed on github pages at https://sdsc-ord.github.io/gimie.
A CI pipeline deploys the documentation to the
gh-pagesbranch on every new commit tomain.The website contains a few introduction pages and tutorials subject to change. A documentation for the python API and the command line interface is generated automatically on every new build, using the sphinx extension
autodoc, andsphinx-click, respectively.Documentation can be built locally by running
make doc. It is built in thedoc/_builddirectory.