Adding CITATION.cff, docs and github workflow to build docs #4
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
Added optional dependencies for documentation and testing. Added ignoring D205 one-blank-line-required-between-summary-line-and-description to the ruff parameters. Signed-off-by: tgwoodcock <[email protected]>
Signed-off-by: tgwoodcock <[email protected]>
Validated using cffconvert Signed-off-by: tgwoodcock <[email protected]>
…ng docstrings. Signed-off-by: tgwoodcock <[email protected]>
Documentation for the project is based on sphinx with the PyData-Sphinx theme. Signed-off-by: tgwoodcock <[email protected]>
In this way we can set up the required `.mochada_kit/config.json` file (it will be empty).
The correct standard is omitting the `Returns` section if the function does not return anything.
`pip` needs to run with .[doc] to install the dependencies specified in `doc`.
`pandoc` must be installed with apt and not with pip
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.
No description provided.