You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add a new ontodoc script/tool - instead of adding a new tool, the old ontodoc tool was extended to support .rst output. It doesn't run sphinx automatically, though...
[PR Rewriting ontodoc based on domain-battery #742]
Add option to ontodoc to run sphinx automatically
Add small tutorial of how to use the tool
Add ontology metadata documentation to generated documentation
Add more semantic information to generated documentation
Add language to keys for localised values
Add default css file (common for all EMMO domain ontologies, could e.g. be downloaded from a common source...)
Add support for figures (e.g. by displaying links to known image formats as images)
Sort modules in a logical order, e.g. by namespace and import depth
Add a module dependency graph at the top
Add subclasses to generated documentation to support navigating the taxonomy
Is it possible to collapse the sidebar to make it easier to navigate to the right module?
Add anchor by prefLabel, to make it easier for people to find the IRI when one knows the prefLabel
# Description
Rewriting and simplifying the ontodoc tool based on domain-battery. For now the python module is called ontodoc_rst.py.
For each module, document:
- classes
- object properties
- data properties
- annotation properties
- individuals
- datatypes
## Tasks done so far (see #759 for remaining tasks):
- [x] Reproduce all information included in the [battery.rst](https://github.com/emmo-repo/domain-battery/blob/master/sphinx/battery.rst) file
- [x] Add tooling for creating other needed files, like `index.rst` (just a template that the user can improve)
- [x] Add a new ontodoc script/tool - instead of adding a new tool, the old ontodoc tool was extended to support `.rst` output. It doesn't run sphinx automatically, though...
## Type of change
- [ ] Bug fix.
- [x] New feature.
- [ ] Documentation update.
- [x] Test update.
Co-authored-by: francescalb <[email protected]>
Description
Rewrite and simplify the ontodoc tool such that it is easy to use for both EMMO and EMMO-based domain ontologies.
The new version is based on the solution in domain-battery. For now the python module is called ontodoc_rst.py.
Tasks
[PR Rewriting ontodoc based on domain-battery #742]
index.rst
(just a template that the user can improve).[PR Rewriting ontodoc based on domain-battery #742]
.rst
output. It doesn't run sphinx automatically, though...[PR Rewriting ontodoc based on domain-battery #742]
Structure the generated document as follows:
For each module, document:
The text was updated successfully, but these errors were encountered: