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

Build sphinx documentation #51

Closed
bourque opened this issue Apr 2, 2018 · 1 comment
Closed

Build sphinx documentation #51

bourque opened this issue Apr 2, 2018 · 1 comment
Assignees
@SaOgaz
Labels
Documentation

Comments

@bourque
Copy link
Collaborator

bourque commented Apr 2, 2018

Now that we have some actual code with docstrings in our jwql package, we can start adding the tools to build official API documentation. I have done this before with sphinx and it has worked well, so unless anybody has a better suggestion I think we should use that.

The documentation that we build could then be hosted on Read the Docs.
@SaOgaz SaOgaz mentioned this issue Apr 4, 2018
Merged
@bourque
Copy link
Collaborator Author

bourque commented Apr 18, 2018

This is solved via #53. Any future changes to the docs will be in separate issues and PRs.

@bourque bourque closed this as completed Apr 18, 2018
bourque pushed a commit to bourque/jwql that referenced this issue Apr 2, 2019
@SaOgaz
first pass at getting sphinx and automodapi running, not storing auto…
ddb16a0 
…modapi generated docs for now. spacetelescope#51
bourque pushed a commit to bourque/jwql that referenced this issue Apr 2, 2019
@SaOgaz
Adding readthedocs files, issue spacetelescope#51
e6ac172
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SaOgaz SaOgaz

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bourque @SaOgaz