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

Sphinx integration #5

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Sphinx integration #5

wants to merge 3 commits into from

Conversation

infispiel
Copy link
Member

Adding Sphinx integration to the repository for documentation. Resolves #4.

Requirements:

  • Correctly formatted
  • Has at least one line of description for every function
  • Major models in medford_models should have at least one line of description, where a Major model is a token that is considered important and non-derivative (i.e. D-Ref and D-Copy are derivative of Data.)

Polina H. Shpilker added 3 commits October 8, 2021 14:31
@infispiel infispiel added the documentation Improvements or additions to documentation label Oct 8, 2021
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.

Add sphinx-rtd docstrings to existing methods, classes, etc
1 participant