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

Create auto-documentation for reference guide using Sphinx #76

Closed
dimberman opened this issue Feb 7, 2022 · 0 comments · Fixed by #163
Closed

Create auto-documentation for reference guide using Sphinx #76

dimberman opened this issue Feb 7, 2022 · 0 comments · Fixed by #163
Assignees
@utkarsharma2
Labels
documentation Improvements or additions to documentation priority/critical Critical priority
Milestone
0.7.x

Comments

@dimberman
Copy link
Collaborator

Acceptance criteria:

  • Create a nox command that generates all documentation based on docstrings in our API
  • This ticket does not concern hosting the documentation or filling in the docstrings
@dimberman dimberman added documentation Improvements or additions to documentation priority/critical Critical priority labels Feb 7, 2022
@tatiana tatiana added this to the 0.6.1 milestone Feb 21, 2022
@tatiana tatiana changed the title Create auotodocumentation for reference guide using Sphinx Create auto-documentation for reference guide using Sphinx Feb 21, 2022
@utkarsharma2 utkarsharma2 self-assigned this Mar 3, 2022
@utkarsharma2 utkarsharma2 mentioned this issue Mar 4, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@utkarsharma2 utkarsharma2

Labels
documentation Improvements or additions to documentation priority/critical Critical priority
Projects
None yet
Milestone
0.7.x
Development

Successfully merging a pull request may close this issue.

Sphinx astronomer/astro-sdk
3 participants
@tatiana @dimberman @utkarsharma2