Skip to content

Create some sphinx documentation and host on readthedocs.io #135

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

Open
3 tasks
ehashman opened this issue Jan 24, 2019 · 0 comments
Open
3 tasks

Create some sphinx documentation and host on readthedocs.io #135

ehashman opened this issue Jan 24, 2019 · 0 comments

Comments

@ehashman
Copy link
Member

auditwheel's documentation is sorely lacking, and that gap makes it harder to contribute and use. Hosting some documentation on readthedocs.io would be awesome.

I'd like to see the following documentation written:

  • a proper usage guide for the many subcommands (beyond a couple README examples and --help info)
  • an examples page, which shows how various projects use auditwheel
  • a "why" page, with information on the manylinux policies and links to the relevant PEPs

It might also be nice to add a stretch goal of developer documentation that explains the codebase's layout but maybe let's start small 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants