set up github.io with schema as markdown (input for mkdocs)

INCATools / dead_simple_owl_design_patterns

A simple system for specifying OWL class design patterns for OBO-ish ontologies.

http://incatools.github.io/dead_simple_owl_design_patterns/

GNU General Public License v3.0

42 stars 5 forks source link

set up github.io with schema as markdown (input for mkdocs) #66

Open dosumis opened 3 years ago

dosumis commented 3 years ago

Aim: generate browsable, human-readable documentation of DOSDP JSON SCHEMA

[ ] Research existing auto-documentation options - markdown output preferred, but we could use static html generator if better.
[ ] ...

hkir-dev commented 3 years ago

First version of the auto-generated documentation exists here Used jsonschema2md for basic generation and decorated by using a custom config file. For this task, needed to update (such as adding doc_type etc.) existing schema a little: new schema Can you share your recommendations for better a documentation.

hkir-dev commented 3 years ago

Mkdocs documentation publishing completed: https://incatools.github.io/dead_simple_owl_design_patterns/

Github action is triggered when; new release, updating README.md or files under docs/ (in the master branch only)