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.

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

Add a docs build #220

Closed
craigds opened this issue Aug 21, 2020 · 1 comment · Fixed by #573
Closed

Add a docs build #220

craigds opened this issue Aug 21, 2020 · 1 comment · Fixed by #573

Comments

@craigds
Copy link
Member

craigds commented Aug 21, 2020

Add a docs build.

We shoudl have a docs/ dir containing a bunch of restructuredtext, and build them using sphinx or similar into a readthedocs site.

To start with this should be the same usage docs as exposed by sno help, but it can easily grow from there. We have a bunch of assorted docs in the wiki and markdown files in the codebase, that should be included in a docs build.

Having them in a github wiki is okay but:

  • it's hard to keep doc changes in sync with code changes (i.e. they're not included in PRs)
  • they're not available from the command-line
  • there's no possibility of auto-generating any documentation; it's all manual point-and-click editing
@rcoup
Copy link
Member

rcoup commented Aug 21, 2020

I agree 👍

  • they're not available from the command-line
  • there's no possibility of auto-generating any documentation; it's all manual point-and-click editing

FWIW, you can access Github wikis as a repo and it supports various flavours of structured text: https://docs.github.com/en/github/building-a-strong-community/adding-or-editing-wiki-pages

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

Successfully merging a pull request may close this issue.

2 participants