Commit Graph

51 Commits

Author SHA1 Message Date
182fa24214 Add docs for project deps config option 2021-05-05 22:17:30 -04:00
e4139d9875 Update docs with new runtime option
Fix formatting in example path
2021-05-05 22:17:29 -04:00
1f449c038f Update badges 2021-04-19 23:32:26 -04:00
efdc2f7f26 Update documentation with new option details 2021-04-19 23:32:26 -04:00
cddfdba0ae Overhaul documentation to improve readability (again) 2021-04-19 23:01:02 -04:00
19828a92f0 Format markdown files with mdformat 2021-04-16 01:57:42 -04:00
5dc5617000 Update readme badges to be prettier 2021-02-10 00:35:55 -05:00
469ce4c905 Update feature roadmap with latest changes 2021-01-27 18:05:58 -05:00
5b5896191f Clarify local dev requirements 2021-01-27 18:04:02 -05:00
cc54e6243a Add dev makefile target for setting up the local dev env 2021-01-27 18:00:24 -05:00
af66cd6d06 Fix changelog URL formatting 2021-01-22 18:28:12 -05:00
b62e13afc7 Add link to changelog 2021-01-16 21:39:34 -05:00
a7d9b25b62 Fix broken links in readme 2020-12-05 18:31:44 -05:00
8356d52c4f Update project project status from alpha to beta 🎉 2020-12-05 18:31:44 -05:00
1941a103d3 Update contributor, devel, and roadmap documentation 2020-12-05 18:31:44 -05:00
0ad5fb7219 Overhaul basic usage documentation to improve clarity
Add intra document links
Update to document new/updated features
Add badge for downloads per month
Update badge order
2020-12-05 18:30:09 -05:00
ea518d1201 Reorder TOC
Add garbage to email to (hopefully) avoid scraping
2020-12-05 18:30:09 -05:00
03f46d34f3 Rewrite usage reference documentation to improve clarity
Add more details to error documentation
Update error and option documentation to be referenceable via slugs
Add docs for missing --require-poetry option
Add more crosslinks to assit with navigation
2020-12-05 18:30:09 -05:00
e37c166a8b Misc meta fixups
Fix dumping pypi API key to stdout when using "make publish" target
Fix outdated version in example output of docs
2020-11-12 21:13:55 -05:00
3d6d39eca8 Add note about installation via tox requires config option
Fixes #13
2020-11-12 21:12:38 -05:00
accb4c3278 Update drawbacks section with new info 2020-11-12 19:31:31 -05:00
ea183553c4 Rewrite usage examples section into reference section
Fixes #20
2020-11-12 19:31:30 -05:00
5c5536581b Update quickstart docs with new config option usage with locked_deps 2020-11-12 18:45:02 -05:00
c14313b7b0 Fix overlooked roadmap step that didn't get checked off 2020-11-12 00:32:22 -05:00
5979ec7a8a Add documentation for new config option 2020-10-28 16:26:31 -04:00
3e98ec81eb Update beta roadmap features list 2020-10-22 21:16:32 -04:00
6075ea6a3e Update readme with development progress 2020-10-22 20:47:44 -04:00
699fb347da Add links to other poetry tox plugins 2020-10-22 00:06:37 -04:00
a3bfd2687a Remove obsoleted documentation from readme
Clarify developer poetry requirement
Work on #12
2020-10-22 00:03:19 -04:00
6b92189e50 !fixup 2020-10-11 20:10:30 -04:00
0fbc77c2c4 Add CI status badge 2020-10-11 20:08:43 -04:00
ee6f939b6a Fix links to roadmap issues 2020-09-29 00:58:04 -04:00
82678e81e8 Add issue links for relevant roadmap items 2020-09-29 00:56:22 -04:00
5411025612 Proofreading and editing fixes
Check spelling more thoroughly
Improve clarity in a few places
Fix grammar mistakes
Fix docs that didn't get updated for the 0.2 overhaul
2020-09-29 00:51:08 -04:00
e28159060d Add badge links
Add black code format badge
2020-09-27 20:59:41 -04:00
edcef918b3 Rename 'usage' section to 'usage examples' 2020-09-27 19:41:29 -04:00
beba9416be Add note about root env setting inheritance breaking child envs 2020-09-27 19:38:42 -04:00
78efd82c82 Add quickstart section 2020-09-27 14:51:12 -04:00
5476f4ab11 Update example errors with new names, messages, and formatting 2020-09-27 14:45:11 -04:00
a4d1c1e4df Add missing drawback about poetry unsafe dependencies
Add item to beta specification to fix/mitigate this somehow
2020-09-27 14:45:11 -04:00
fb1ac3b0de Misc documentation updates
Fix inconsistent env naming in example ini snippets
Fix PS1 in demo commands to make it clearer what they are
Rename 'getting started' section to 'usage'
Add note about main branch and tag usage
2020-09-27 14:44:50 -04:00
f20e434f2c Overhaul usage documentation
Add better installation documentation
Add configuration examples and usage walk through using new design system
Update roadmap with feature changes for 0.2
Clarify drawbacks section with more useful context
2020-09-27 14:02:39 -04:00
5dfbca4ff6 Update docs to indicate dev package installation support 2020-09-25 00:56:21 -04:00
b95ad7a3a0 Update readme with completed trivial test step 2020-09-24 21:58:39 -04:00
215ee011d3 Update problem and usecase description to reflect wider context
This version also not written at 3am
2020-09-23 23:30:25 -04:00
51386fba1a Add roadmap section for beta and stable work 2020-09-23 23:30:25 -04:00
748eab5b76 Add code of conduct
Add contributing section to readme
2020-09-23 23:30:19 -04:00
308423a86c Add table of contents
Add developing docs section
Add current limitations docs section
2020-09-23 23:29:57 -04:00
417747c332 Add basic usage instructions
Add badges
2020-09-23 21:43:41 -04:00
3711f4b42f Add more detailed project overview 2020-09-23 02:53:25 -04:00