search

ModECI / modelspec

Functionality for specifying models & enabling automatic serialization - will be used by MDF & NeuroMLlite
https://modeci.github.io/modelspec/
Apache License 2.0
3 stars 9 forks source link

Add sphinx documentation #40

Closed Onoyiza closed 1 year ago

Onoyiza commented 1 year ago

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.

pgleeson commented 1 year ago

Thanks, looks good! I don;t think the _autosummary directory need to be committed though, it gets regenerated.

Onoyiza commented 1 year ago

Thank you! I have removed the _autosummary directory.