emmo-repo / EMMOntoPy

Library for representing and working with ontologies in Python
https://emmo-repo.github.io/EMMOntoPy
BSD 3-Clause "New" or "Revised" License
40 stars 9 forks source link

Added figures to generated documentation #767

Open jesper-friis opened 4 months ago

jesper-friis commented 4 months ago

Added figures to generated documentation. If the value of a property matches a regex for a figure on the web, it will be included in the documentation.

Further work: The figure size should probably be adjusted to not make the table too large. Probably preferred to only show a thumbnail-sized version of the figure in the table. The full size could be shown by clicking. Easier to play with in a following-up PR when this is applied to EMMO.


Also, added prefLabel as anchoring points such that one can use the browser to easily get documentation of a concept one knows the prefLabel of.

For example, entering

https://w3id.org/emmo#Atom

should bring you to the section in the html doc that documents Atom.

Description

Type of change

Checklist

This checklist can be used as a help for the reviewer.

Comments

codecov[bot] commented 4 months ago

Codecov Report

Attention: Patch coverage is 86.36364% with 3 lines in your changes missing coverage. Please review.

Project coverage is 72.57%. Comparing base (5b6785f) to head (65b2fa6).

Files Patch % Lines
ontopy/ontodoc_rst.py 85.71% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #767 +/- ## ========================================== + Coverage 72.52% 72.57% +0.05% ========================================== Files 18 18 Lines 3701 3716 +15 ========================================== + Hits 2684 2697 +13 - Misses 1017 1019 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.