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

Convert README into documentation website #71

Closed
simonw opened this issue May 24, 2022 · 3 comments
Closed

Convert README into documentation website #71

simonw opened this issue May 24, 2022 · 3 comments
Labels
enhancement New feature or request

Comments

@simonw
Copy link
Owner

simonw commented May 24, 2022

Like I did recently for https://shot-scraper.datasette.io/
@simonw simonw added the enhancement New feature or request label May 24, 2022
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Initial Sphinx config + multi page docs, refs #71
18f1672
@simonw
Copy link
Owner Author

simonw commented Aug 12, 2022

I imported the project into ReadTheDocs: https://readthedocs.org/projects/s3-credentials/

@simonw
Copy link
Owner Author

simonw commented Aug 12, 2022

Now live here: https://s3-credentials.readthedocs.io/en/latest/

simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Renamed usage to create, added some internal referenc links - refs #71
50871b7
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Fixed a bunch of Sphinx warnings, refs #71
30f0ad4
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Move help.md to docs/help.md, refs #71
bbfe7ab
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Add ReadTheDocs badge, refs #71
0d7a1ef
@simonw
Copy link
Owner Author

simonw commented Aug 12, 2022

Last step is to decide what stays in the README.

@simonw simonw closed this as completed in 5305082 Aug 12, 2022
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Link to GitHub repo from contributing docs, refs #71
27fca8b
simonw added a commit that referenced this issue Aug 12, 2022
@simonw
Release 0.13
59c9473 
Refs #21, #71, #76, #77
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw