Skip to content
This repository has been archived by the owner on Jan 28, 2020. It is now read-only.

Create API documentation using Sphinx autodoc #55

Closed
pwilkins opened this issue May 28, 2015 · 1 comment
Closed

Create API documentation using Sphinx autodoc #55

pwilkins opened this issue May 28, 2015 · 1 comment
Assignees
@pwilkins
Labels
Acceptance test done

Comments

@pwilkins
Copy link
Contributor

Add Sphinx documentation tools to generate API docs from code docstrings. Uses Google doc style through Napoleon and the Sphinx Bootstrap theme.

  1. Add Sphinx autodoc tooling

. Create TOX env to create Sphinx doc

. Create ReadTheDocs site for LORE documentation
pwilkins added a commit that referenced this issue May 28, 2015
@pwilkins
Add Sphinx autodoc tooling
43d9975 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
@pwilkins pwilkins mentioned this issue May 28, 2015
Merged
pwilkins added a commit that referenced this issue May 28, 2015
@pwilkins
Add Sphinx autodoc tooling
86c5bb2 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 28, 2015
@pwilkins
Add Sphinx autodoc tooling
c0f57c7 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 28, 2015
@pwilkins
Add Sphinx autodoc tooling
f35edc4 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 29, 2015
@pwilkins
Add Sphinx autodoc tooling
ea90f4d 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 29, 2015
@pwilkins
Add Sphinx autodoc tooling
5c63688 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 29, 2015
@pwilkins
Add Sphinx autodoc tooling
d7fbe0f 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
pwilkins added a commit that referenced this issue May 29, 2015
@pwilkins
Add Sphinx autodoc tooling
d9629db 
Add Sphinx documentation tools to generate API docs
from code docstrings. Uses Google doc style through Napoleon
and the Sphinx Bootstrap theme.

See PT story here: https://www.pivotaltracker.com/story/show/95632294

Closes Github issue #55 - #55
@pwilkins
Copy link
Contributor Author

closed by merge of PR#56

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

@pwilkins pwilkins

Labels
Acceptance test done
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pwilkins