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.

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

Enhancement: Sphinx documentation with RTDs #176

Open
4 tasks
damian-romero opened this issue Mar 1, 2021 · 0 comments
Open
4 tasks

Enhancement: Sphinx documentation with RTDs #176

damian-romero opened this issue Mar 1, 2021 · 0 comments
Labels
CI/CD documentation Improvements or additions to documentation enhancement New feature or request p3 Tier-3 issues (lowest level) - will be addressed

Comments

@damian-romero
Copy link
Contributor

Provide documentation through ReadTheDocs.

This tutorial is a good starter. A couple of key points:

  1. Docs will be in a docs/ folder relative to the repo parent
  2. We will keep source and build separate, so answer yes to that question
  3. We will build with python 3.7
  4. We will transfer README.md over and have separate sections (separate .rst files)
  5. We will use sphinx_rtd_theme HTML theme. You will need to include to include the sphinx_rtd_theme extension

Action item:

  • Clean up all docstrings
  • Include requirements.txt under docs/ for Sphinx compilation
  • Include a GitHub Action script
  • Add shields.io badges. See this example
@damian-romero damian-romero added documentation Improvements or additions to documentation enhancement New feature or request CI/CD labels Mar 1, 2021
@damian-romero damian-romero added this to the v0.18.0 milestone Mar 1, 2021
@damian-romero damian-romero self-assigned this Mar 1, 2021
@damian-romero damian-romero added the p2 Tier-2 issues that require addressing but not iminent label Mar 1, 2021
@astrochun astrochun removed this from the v0.18.0 milestone Mar 17, 2021
@damian-romero damian-romero added p3 Tier-3 issues (lowest level) - will be addressed and removed p2 Tier-2 issues that require addressing but not iminent labels Apr 19, 2021
@damian-romero damian-romero removed their assignment May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation enhancement New feature or request p3 Tier-3 issues (lowest level) - will be addressed
Projects
None yet
Development

No branches or pull requests

2 participants