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

Add Sphinx documentation and publish to ReadTheDocs #10

Closed
5 tasks done
astrochun opened this issue May 18, 2021 · 0 comments · Fixed by #11
Closed
5 tasks done

Add Sphinx documentation and publish to ReadTheDocs #10

astrochun opened this issue May 18, 2021 · 0 comments · Fixed by #11
Assignees
@astrochun
Labels
CI/CD documentation Improvements or additions to documentation enhancement New feature or request
Projects
LD-Cool-P Figshare board
Milestone
v0.1.0

Comments

@astrochun
Copy link
Contributor

astrochun commented May 18, 2021 •
edited
Loading

We will host the documentation at ldcoolp-figshare.readthedocs.io.

This is straight forward feature:

  • Include a docs/source folder containing documentation.
  • Add sphinx-build GitHub actions
  • Docstrings update
  • Add instructions for using code
  • Enable with RTDs.org
@astrochun astrochun added CI/CD documentation Improvements or additions to documentation enhancement New feature or request labels May 18, 2021
@astrochun astrochun added this to the v0.1.0 milestone May 18, 2021
@astrochun astrochun self-assigned this May 18, 2021
@astrochun astrochun added this to To do in LD-Cool-P Figshare board via automation May 18, 2021
@astrochun astrochun moved this from To do to In progress in LD-Cool-P Figshare board May 18, 2021
@astrochun astrochun moved this from In progress to To do in LD-Cool-P Figshare board May 18, 2021
@astrochun astrochun changed the title Add documentation for ReadtheDocs using Sphinx Add Sphinx documentation and publish to ReadTheDocs May 18, 2021
@astrochun astrochun moved this from To do to In progress in LD-Cool-P Figshare board May 19, 2021
@astrochun astrochun mentioned this issue May 20, 2021
Merged
LD-Cool-P Figshare board automation moved this from In progress to Done May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@astrochun astrochun

Labels
CI/CD documentation Improvements or additions to documentation enhancement New feature or request
Projects
LD-Cool-P Figshare board
Done
Milestone
v0.1.0
Development

Successfully merging a pull request may close this issue.

Add Sphinx documentation and publish to ReadTheDocs UAL-RE/ldcoolp-figshare
1 participant
@astrochun