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

Docs update #265

Merged
merged 77 commits into from
Dec 7, 2023
Merged

Docs update #265

merged 77 commits into from
Dec 7, 2023

Conversation

kkaris
Copy link
Contributor

@kkaris kkaris commented Dec 4, 2023

This PR updates the documentation in the repository to be more complete, this includes docstrings, file headers and REST API documentation.

A docs build for this branch is set up here: https://miramodel.readthedocs.io/en/docs-update/index.html

Closes #264

@kkaris kkaris linked an issue Dec 4, 2023 that may be closed by this pull request
33 tasks
@kkaris
Copy link
Contributor Author

kkaris commented Dec 5, 2023

The schema test erred because it was generated locally using pydantic 1.10.12, while the latest pydantic<2 is 1.10.13.

@kkaris kkaris added the documentation Improvements or additions to documentation label Dec 5, 2023
@kkaris kkaris requested review from cthoyt and bgyori December 5, 2023 23:30
@kkaris kkaris marked this pull request as ready for review December 5, 2023 23:30
@kkaris
Copy link
Contributor Author

kkaris commented Dec 6, 2023

(copied comment from issue)
A bunch of classes are excluded from the docs for the templates module, mira.metamodel.templates, see docs/source/metamodel.rst:

Templates (:py:mod:`mira.metamodel.templates`)
----------------------------------------------
.. automodule:: mira.metamodel.templates
    :members:
    :exclude-members: Concept, ControlledConversion, NaturalConversion, Provenance, Template, NaturalDegradation, NaturalProduction, GroupedControlledConversion
    :show-inheritance:

Should we include them now that we anticipate automated reading of the documentation?

mira/metamodel/decapodes.py Outdated Show resolved Hide resolved
mira/metamodel/decapodes.py Outdated Show resolved Hide resolved
mira/metamodel/decapodes.py Outdated Show resolved Hide resolved
@bgyori bgyori merged commit bcf9ef5 into main Dec 7, 2023
4 checks passed
@bgyori bgyori deleted the docs-update branch December 20, 2023 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs update
3 participants