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 documentation #5

Open
6 of 9 tasks
agriyakhetarpal opened this issue Jan 2, 2024 · 1 comment · May be fixed by #77
Open
6 of 9 tasks

Add documentation #5

agriyakhetarpal opened this issue Jan 2, 2024 · 1 comment · May be fixed by #77
Labels
documentation Improvements or additions tot the documentation for users and developers

Comments

@agriyakhetarpal
Copy link
Owner

agriyakhetarpal commented Jan 2, 2024 •
edited
Loading

Some documentation for the project

  1. Get started
  • Usage instructions
  • Multiple installations
  1. Background
  • History and why I created this, and use cases
  • Limitations (there are a lot!)
  • Comparisons with other package managers
  • How this pip-installable distribution can help

See #11 for the above.

  1. Sphinx (closed as not planned since I do not need versioning for this project and won't benefit from the additional maintenance required from hosted Markdown documentation)
  • Hosted documentation
  • Add extensions
  • Versioning if necessary
@agriyakhetarpal agriyakhetarpal added the documentation Improvements or additions tot the documentation for users and developers label Jan 2, 2024
@agriyakhetarpal agriyakhetarpal mentioned this issue Jan 3, 2024
Merged
@agriyakhetarpal
Copy link
Owner Author

agriyakhetarpal commented Feb 8, 2024 •
edited
Loading

This package itself can be used to build the current GitHub documentation using a docs-related Hugo theme and then deployed on GitHub Pages

@agriyakhetarpal agriyakhetarpal linked a pull request Apr 6, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions tot the documentation for users and developers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Move documentation to separate website agriyakhetarpal/hugo-python-distributions
1 participant
@agriyakhetarpal