docs: Switches to mkdocs for building and deploying documentation #123
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
ns-rse
force-pushed
the
ns-rse/122-mkdocs-how-to-add-functions
branch
2 times, most recently
from
98e0526 to
eb32ef2
Compare
Closes #122 - [x] Switch to [mkdocs](https://www.mkdocs.org) and copy over existing content. - [x] Add [mkdocsstrings](https://mkdocstrings.github.io/) - [x] Add following pages - [x] `index.md` - Overview and what it does - [x] `installation.md` - how to install - [x] `workflow.md` - the need to pre-process using `ruffus` / `cgat` pipeline - [x] `extending.md` - how to add a Python module, the necessary wrapper and argparse options to include it in the command line programme. - [x] `api/<module>.md` individual Markdown files for include the API of each module. - [ ] [Mermaid](https://mkdocs-mermaid2.readthedocs.io/en/master/) support. - [x] [Material Theme](https://squidfunk.github.io/mkdocs-material/) - [x] [Versioning](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/) Useful resources are linked above. Things I couldn't work out... - Global configuration of `mkdocstrings` at the moment these are added under the individual API sections, would be cleaner to have this defined once in `mkdocs.yaml` but whenever I tried adding [global options](https://mkdocstrings.github.io/usage/#global-options) rendering failed. - Mermaid diagram embedding doesn't yet work, see [troubleshooting](https://mkdocs-mermaid2.readthedocs.io/en/master/troubleshooting/)
ns-rse
force-pushed
the
ns-rse/122-mkdocs-how-to-add-functions
branch
from
8a5b7a9 to
93bfc3c
Compare
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.
Closes #122
index.md- Overview and what it doesinstallation.md- how to installworkflow.md- the need to pre-process usingruffus/cgatpipelineextending.md- how to add a Python module, the necessary wrapper and argparse options to include it in thecommand line programme.
api/<module>.mdindividual Markdown files for include the API of each module.Useful resources are linked above. Things I couldn't work out...
mkdocstringsat the moment these are added under the individual API sections, would be cleaner to have this defined once inmkdocs.yamlbut whenever I tried adding global options rendering failed.