Non code tweaks #15
Non code tweaks #15
Conversation
| @@ -3,7 +3,7 @@ python: 3.7 | |||
|
|
|||
| install: | |||
| - pip install pipenv | |||
| - pipenv install --dev | |||
| - pipenv install --dev --deploy | |||
There was a problem hiding this comment.
I prefer have the --deploy flag on Travis installs to make Travis fail if ever the Pipfile and Pipfile.lock are out of sync.
| @@ -1,6 +1,7 @@ | |||
| # <Title_Here> | |||
| ## What? | |||
| ## Why? | |||
| ## PR Checklist | |||
There was a problem hiding this comment.
People have been putting a heading here, which I like. Might as well automatically put it there. Let me know if you prefer the "QA Strategy" heading instead.
| the repo, run | ||
| This library is documented using Sphinx. To generate documentation, make sure all **dev** | ||
| dependencies are installed (e.g. you've installed via ``pip install -e .[dev]``). Within | ||
| the *docs/* subdirectory, run: |
There was a problem hiding this comment.
See #14. We should use Github Pages to automatically generate and publish documentation. I've always wanted to do it, but it's only allowed for public repos, so this might be my one chance.
There was a problem hiding this comment.
How do we get Github Pages automatically running?
There was a problem hiding this comment.
It shouldn't be too hard. There are tons of tutorials online
| the repo, run | ||
| This library is documented using Sphinx. To generate documentation, make sure all **dev** | ||
| dependencies are installed (e.g. you've installed via ``pip install -e .[dev]``). Within | ||
| the *docs/* subdirectory, run: |
There was a problem hiding this comment.
How do we get Github Pages automatically running?
Some small updates to non-code files
What?
configurationmodule to auto-generated documentationpipenv install --dev --deployWhy?
These kinds of things really bug me if they aren't taken care of.
PR Checklist
Breaking Changes
Nosiribubski