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

More docs #43

Merged
merged 20 commits into from
Sep 23, 2022
Merged

More docs #43

merged 20 commits into from
Sep 23, 2022

Conversation

kkaris
Copy link
Contributor

@kkaris kkaris commented Sep 22, 2022

This PR substantially updates the documentation to bring it up to date with the current state of the repository.

Branch build: https://miramodel.readthedocs.io/en/more-docs/

Notable changes:

  • autodoc-pydantic is activated and used, particularly in mira.metamodel.templates. For this to work, top level docstrings had to be added to the BaseModels in the module.
  • Missing notebook links are added to README

Outstanding issues:

  • Figure out why wget is not installed in the docs build environment when several submodule in mira.dkg are dependent on it
  • Fix Name clash #42?
  • Review added docstrings, especially in mira.metamodel.templates

@bgyori bgyori merged commit 58ea5a4 into gyorilab:main Sep 23, 2022
@kkaris kkaris deleted the more-docs branch September 23, 2022 03:59
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.

Name clash
2 participants