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

Documentation #47

Open
10 tasks
GhostofGoes opened this issue May 9, 2019 · 0 comments
Open
10 tasks

Documentation #47

GhostofGoes opened this issue May 9, 2019 · 0 comments
Assignees
@GhostofGoes
Labels
enhancement General improvements or adding support for new OS platforms
Milestone
Stable Release (1.0)

Comments

@GhostofGoes
Copy link
Owner

GhostofGoes commented May 9, 2019 •
edited

Finish writing proper documentation

  • Complete documentation of the API (auto-generate using Sphinx)
  • Static documentation of CLI arguments (using sphinxcontrib-autoprogram)
  • Add Glossary of terms and link to the glossary from inside docs/code (e.g. acronyms)
  • Integrate CONTRIBUTING doc
  • Integrate packaging and release docs
  • Improve the current usage guide and add more examples
  • Page detailing the architecture (after the method refactor is finished)
  • Setup ReadTheDocs
  • Configure ReadTheDocs hook to update with new releases
  • Add ReadTheDocs URL to project_urls in setup.py
@GhostofGoes GhostofGoes added this to the Stable Release (1.0) milestone May 9, 2019
@GhostofGoes GhostofGoes self-assigned this Oct 1, 2019
@GhostofGoes GhostofGoes added the enhancement General improvements or adding support for new OS platforms label Oct 29, 2021
@GhostofGoes GhostofGoes removed this from To do in Stable Release (1.0) Jan 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GhostofGoes GhostofGoes

Labels
enhancement General improvements or adding support for new OS platforms
Projects
None yet
Milestone
Stable Release (1.0)
Development

No branches or pull requests
1 participant
@GhostofGoes