Skip to content

Add sphinx documentation #40

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

Merged
merged 10 commits into from
Jun 21, 2023

Conversation

Onoyiza
Copy link
Contributor

@Onoyiza Onoyiza commented Jun 19, 2023

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
Copy link
Member

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

@Onoyiza
Copy link
Contributor Author

Onoyiza commented Jun 21, 2023

Thank you! I have removed the _autosummary directory.

@pgleeson pgleeson merged commit 0b31080 into ModECI:development Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants