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.

Sign up for GitHub

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

Jump to bottom

Fix MkDocs build warnings and CI job #254

Merged
merged 2 commits into from
Oct 14, 2021
Merged

Fix MkDocs build warnings and CI job #254

merged 2 commits into from
Oct 14, 2021

Conversation

CasperWA
Copy link
Contributor

@CasperWA CasperWA commented Oct 12, 2021 •
edited
Loading

Description:

Fixes #250

Add attr_list extension to accommodate the width specifications of images.

Remove unresolvable cross-references, re-create resources, or re-direct cross-references.

Update documentation, fixing retrieval and rendering.

Streamline create-api-reference-docs invoke task to be more EMMOntoPy-specific.

This also treats the emmopy/emmocheck.py file differently, when creating the API Reference MarkDown file for it, setting the handling of base/parent classes to False; meaning parent classes should not be considered for the documentation (as this results in warnings from the unittest.case.TestCase class).

Type of change:

  • Bug fix.
  • New feature.
  • Documentation 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:

@CasperWA
Fix MkDocs build warnings
311e94c 
Add `attr_list` extension to accommodate the width specifications of
images.

Remove unresolvable cross-references, re-create resources, or re-direct
cross-references.

Update documentation, fixing retrieval and rendering.

Streamline `create-api-reference-docs` invoke task to be more
EMMOntoPy-specific.
@CasperWA CasperWA requested a review from francescalb October 12, 2021 12:33
@francescalb
Copy link
Collaborator

Why do you want to remove all the links in the .md?

@CasperWA
Copy link
Contributor Author

Why do you want to remove all the links in the .md?

I don't think I am? Which ones do you mean specifically?
The only links I'm actually removing is the ones to local "owl" files that don't exist?

@francescalb
Copy link
Collaborator

francescalb commented Oct 12, 2021 via email

@CasperWA
Copy link
Contributor Author

Yes, you are right. The should be .ttl files and not local.

Yeah - I was confused about these lines.

I think maybe they are there because this whole part of the example is taken "out of context" in a way? If it is generated as part of the full EMMO documentation, it might make sense :)

If you have some good alternative targets for the links here, feel free to add suggestions or perhaps direct me to the a base URL where I can find them?

@CasperWA
Copy link
Contributor Author

This is ready to go with an accepting review.

francescalb
francescalb approved these changes Oct 14, 2021
View reviewed changes
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 agree, inthe README the only example is using emmo-inferred, which means that it is not using an ontology using the original structure. It is a little difficult to find the correct .ttl files on on the emmo official repository (emmo-repo.github.io). In this example we should point to the 'latest' here, so as not to have an outdated example from the start. Let's therefore skip it for now.

@CasperWA CasperWA merged commit 99fcfa0 into master Oct 14, 2021
@CasperWA CasperWA deleted the cwa/fix-250-docs-build-warnings branch October 14, 2021 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@francescalb francescalb francescalb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix documentation build warnings
2 participants
@CasperWA @francescalb