Add sphinx documentation #40
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @pgleeson I have built the documentation for modelspec. The documentation currently has three parts or sections, which are; Content, Example and API Reference.
Content Subsection includes:
Modelspec (Introduction)
Quickstart
Installation
Example:
Readme that illustrates an example (document)
API Reference:
The classes, functions and attributes used in modelspec
I created a generate.py file to copy the README.md of modelspec into Introduction.md and copy all instances of "document" file in all the formats (py, json, yaml, bson) used.
I look forward to your review on it and on what I should be adding that is not there.
Thank you.