Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | Update repo links, changelog, and contributors | Jordan Cook | 2022-05-15 | 1 | -10/+10 |
| | |||||
* | use https for links | 谭九鼎 | 2022-05-09 | 1 | -1/+1 |
| | |||||
* | Move detailed backend docs from rst docstings to md files | Jordan Cook | 2022-04-16 | 1 | -7/+1 |
| | |||||
* | Add some more 'getting started' details to contributing guide | Jordan Cook | 2021-09-14 | 1 | -6/+12 |
| | |||||
* | Move Roman's original Code Shelter note under Project Info docs | Jordan Cook | 2021-08-28 | 1 | -7/+8 |
| | |||||
* | Fix some typos in contributing guide | Jordan Cook | 2021-08-28 | 1 | -11/+10 |
| | |||||
* | Add some more details to contributing guide, and add sample caches for 0.7 ↵ | Jordan Cook | 2021-08-10 | 1 | -12/+15 |
| | | | | patch versions | ||||
* | Update contributing guide | Jordan Cook | 2021-08-08 | 1 | -14/+45 |
| | |||||
* | Add more details to docs about pre-release builds | Jordan Cook | 2021-06-20 | 1 | -8/+19 |
| | | | | Based on issue #295 | ||||
* | Add tests and docs | Jordan Cook | 2021-06-11 | 1 | -1/+1 |
| | |||||
* | Convert packaging config to poetry | Jordan Cook | 2021-05-09 | 1 | -2/+2 |
| | |||||
* | Update readthedocs links to point to stable version instead of latest | Jordan Cook | 2021-05-08 | 1 | -2/+8 |
| | |||||
* | Use pytest-order to order tests; remove ipdb recommendation | Jordan Cook | 2021-04-19 | 1 | -10/+0 |
| | |||||
* | Add some more info about testing | Jordan Cook | 2021-04-18 | 1 | -2/+2 |
| | |||||
* | Set up automatic pre-release builds from dev branch | Jordan Cook | 2021-04-17 | 1 | -0/+9 |
| | |||||
* | Add option to use pytest-httpbin instead of httpbin container | Jordan Cook | 2021-04-12 | 1 | -4/+18 |
| | |||||
* | Move readthedocs container to a separate docker-compose file | Jordan Cook | 2021-04-10 | 1 | -2/+3 |
| | |||||
* | Add Dockerfile + docker-compose config to make it easier to run the ↵ | Jordan Cook | 2021-04-04 | 1 | -10/+7 |
| | | | | readthedocs build container | ||||
* | Update to Ubuntu 20.04 build image for readthedocs | Jordan Cook | 2021-04-03 | 1 | -1/+1 |
| | |||||
* | Make Readme more concise again, and split main usage docs into 'Quickstart' ↵ | Jordan Cook | 2021-04-03 | 1 | -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 Cook | 2021-04-03 | 1 | -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 docs | Jordan Cook | 2021-04-01 | 1 | -1/+20 |
| | |||||
* | Split tests into unit and integration tests and run separately in CI; update ↵ | Jordan Cook | 2021-03-31 | 1 | -2/+11 |
| | | | | Contributing Guide with more notes on testing | ||||
* | More usage examples, formatting, and editing for Readme + Sphinx docs | Jordan Cook | 2021-03-24 | 1 | -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 typo | Jordan Cook | 2021-03-04 | 1 | -1/+1 |
| | |||||
* | Add instructions for building docs using Readthedocs Docker container | Jordan Cook | 2021-03-03 | 1 | -0/+15 |
| | |||||
* | Add a contributing guide | Jordan Cook | 2021-03-03 | 1 | -0/+88 |