INCATools/dead_simple_owl_design_patterns

Host auto-generated documentation on READTHEDOCS

Opened this issue · 5 comments

dosumis commented

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.

matentzn commented

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

dosumis commented

@matentzn - can you point @hkir-dev to an example of auto-deployment with mkdocs? Also - can you point to the documentation framework you've been following for other projects (with 4 major types of doc clearly defined).

matentzn commented

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/

  • 👍1
dosumis commented

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.

hkir-dev commented

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