Host auto-generated documentation on READTHEDOCS
Opened this issue · 5 comments
Full auto-generated documentation for DOSDP schema should be hosted on ReadTheDoc or mkdocs+github.io. Should be linked from top level README.md (which right now is the set to display on PyPi page for dosdp.
readthedocs is a service, just use mkdocs with readthedocs template, example
http://pato-ontology.github.io/pato/
config https://github.com/pato-ontology/pato/blob/master/mkdocs.yaml
We don't have any auto-deployment set up (with say Github actions) - but I have an idea on how to do it now.
Here is the framework we should be using for organising docs: https://diataxis.fr/
Possible relevant:
https://github.com/VirtualFlyBrain/VFB_connect/tree/master/.github/workflows
This repo also has autodeployment of doc derived from python docstrings to readthedocs. Framework may not be relevant though.
Mkdocs documentation publishing completed: https://incatools.github.io/dead_simple_owl_design_patterns/
Github action is triggered on; new release, README.md or files under docs/ updated in the master branch