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

Document models using Sphinx #42

Closed
alexdlaird opened this issue Dec 31, 2017 · 1 comment
Closed

Document models using Sphinx #42

alexdlaird opened this issue Dec 31, 2017 · 1 comment
Assignees
@alexdlaird
Labels
documentation This issue requires a documentation change

Comments

@alexdlaird
Copy link
Member

alexdlaird commented Dec 31, 2017 •
edited
Loading

A model's spec should be fully defined so we can generate documentation using Sphinx.

Once this is done, an ideal setup would be to host this using GitHub Pages. All model create methods should then reference this documentation.
@alexdlaird alexdlaird added documentation This issue requires a documentation change open source migration Legacy label, used to track the migration to open source labels Dec 31, 2017
@alexdlaird alexdlaird added this to the 1.0.0 milestone Dec 31, 2017
@alexdlaird alexdlaird self-assigned this Dec 31, 2017
@alexdlaird alexdlaird changed the title Model specs should be well defined on the create method Document models using Sphinx Jan 3, 2018
@alexdlaird alexdlaird removed the open source migration Legacy label, used to track the migration to open source label Jan 3, 2018
@alexdlaird alexdlaird modified the milestones: 1.0.0, 1.1.0 Jan 3, 2018
@alexdlaird alexdlaird removed this from the 1.1.0 milestone Jan 31, 2018
@alexdlaird
Copy link
Member Author

Closing, as the Helium project is not currently active.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexdlaird alexdlaird

Labels
documentation This issue requires a documentation change
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alexdlaird