Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added figures to generated documentation #767

Merged
merged 9 commits into from
Nov 6, 2024

Conversation

jesper-friis
Copy link
Collaborator

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

  • Bug fix.
  • New feature.
  • Documentation update.
  • Test update.

Checklist

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

  • Is the code easy to read and understand?
  • Are comments for humans to read, not computers to disregard?
  • Does a new feature has an accompanying new test (in the CI or unit testing schemes)?
  • Has the documentation been updated as necessary?
  • Does this close the issue?
  • Is the change limited to the issue?
  • Are errors handled for all outcomes?
  • Does the new feature provide new restrictions on dependencies, and if so is this documented?

Comments

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.
Copy link

codecov bot commented Jun 2, 2024

Codecov Report

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

Project coverage is 72.72%. Comparing base (420c9e5) to head (56d9773).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
ontopy/ontodoc_rst.py 85.71% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #767      +/-   ##
==========================================
+ Coverage   72.63%   72.72%   +0.08%     
==========================================
  Files          18       18              
  Lines        3706     3721      +15     
==========================================
+ Hits         2692     2706      +14     
- Misses       1014     1015       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@francescalb francescalb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see no example or test.

At least I want t more through description in the code itself. E.g. adapt text in the PR comment and include it in the documentation.

@jesper-friis
Copy link
Collaborator Author

I see no example or test.

At least I want t more through description in the code itself. E.g. adapt text in the PR comment and include it in the documentation.

It is tested, both online and in the tests/ folder

@jesper-friis jesper-friis enabled auto-merge (squash) November 6, 2024 13:03
@jesper-friis jesper-friis enabled auto-merge (squash) November 6, 2024 13:08
@jesper-friis jesper-friis enabled auto-merge (squash) November 6, 2024 13:10
@jesper-friis jesper-friis merged commit 45d278d into master Nov 6, 2024
12 checks passed
@jesper-friis jesper-friis deleted the add-figures-to-generated-documentation branch November 6, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants