summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAgeFilesLines
* Update repo links, changelog, and contributorsJordan Cook2022-05-151-10/+10
|
* use https for links谭九鼎2022-05-091-1/+1
|
* Move detailed backend docs from rst docstings to md filesJordan Cook2022-04-161-7/+1
|
* Add some more 'getting started' details to contributing guideJordan Cook2021-09-141-6/+12
|
* Move Roman's original Code Shelter note under Project Info docsJordan Cook2021-08-281-7/+8
|
* Fix some typos in contributing guideJordan Cook2021-08-281-11/+10
|
* Add some more details to contributing guide, and add sample caches for 0.7 ↵Jordan Cook2021-08-101-12/+15
| | | | patch versions
* Update contributing guideJordan Cook2021-08-081-14/+45
|
* Add more details to docs about pre-release buildsJordan Cook2021-06-201-8/+19
| | | | Based on issue #295
* Add tests and docsJordan Cook2021-06-111-1/+1
|
* Convert packaging config to poetryJordan Cook2021-05-091-2/+2
|
* Update readthedocs links to point to stable version instead of latestJordan Cook2021-05-081-2/+8
|
* Use pytest-order to order tests; remove ipdb recommendationJordan Cook2021-04-191-10/+0
|
* Add some more info about testingJordan Cook2021-04-181-2/+2
|
* Set up automatic pre-release builds from dev branchJordan Cook2021-04-171-0/+9
|
* Add option to use pytest-httpbin instead of httpbin containerJordan Cook2021-04-121-4/+18
|
* Move readthedocs container to a separate docker-compose fileJordan Cook2021-04-101-2/+3
|
* Add Dockerfile + docker-compose config to make it easier to run the ↵Jordan Cook2021-04-041-10/+7
| | | | readthedocs build container
* Update to Ubuntu 20.04 build image for readthedocsJordan Cook2021-04-031-1/+1
|
* Make Readme more concise again, and split main usage docs into 'Quickstart' ↵Jordan Cook2021-04-031-1/+1
| | | | | | | (Readme), 'User Guide', and 'Advanced Usage' sections * Add more details and formatting to changelog * Add some more reference links to classes, methods, and functions mentioned in docs
* Improvements to Sphinx documentation:Jordan Cook2021-04-031-4/+8
| | | | | | | | | | | | | | * Use sphinx-apidoc to auto-generate sources for backend modules * Still manually adding other modules for more control over formatting * Add a couple more contributors I missed * Include contributors on readthedocs * Add 'all' Makefile target and clean auto-generated docs * Remove unused build targets in Makefile * Update interpshinx links that have moved * Fix some interpshinx links * Fix some `:ref:` links using auto-generated labels (and some manually added labels where convenient) * Fix some docstring formatting * Fix remaining build warnings
* Add an example test runner script, and add some more testing info to docsJordan Cook2021-04-011-1/+20
|
* Split tests into unit and integration tests and run separately in CI; update ↵Jordan Cook2021-03-311-2/+11
| | | | Contributing Guide with more notes on testing
* More usage examples, formatting, and editing for Readme + Sphinx docsJordan Cook2021-03-241-2/+2
| | | | | | | | | | | | | * Closes #135, #165 * Add a 'Summary' section at the top of the Readme explaining the scope of requests-cache and why you would want to use it * Add some more info explaining the difference between using `CachedSession` directly vs. patching with `install_cache()` * Move basic examples from 'User Guide' section into Readme * Include Readme in Sphinx docs (using `.. mdinclude::`) and remove duplicate sections * Include Contributing guide in Sphinx docs * Convert History doc to markdown and include in Sphinx docs * Use `automod` options to move main cache documentation from `CacheMixin` back to to `CachedSession`, since that's probably where a user will look first * Add more detailed usage examples to an 'Advanced Usage' section for `CachedSession` options (`filter_fn`, `ignore_parameters`, etc.) * Update example scripts and move them to `examples/` folder
* Fix copy-paste typoJordan Cook2021-03-041-1/+1
|
* Add instructions for building docs using Readthedocs Docker containerJordan Cook2021-03-031-0/+15
|
* Add a contributing guideJordan Cook2021-03-031-0/+88