Sphinx-Cache is a Sphinx extension for storing and restoring the .doctrees cache.
Installation
We recommend using the latest version of Python. Sphinx-Cache supports Python 3.6 and newer versions.
Using pip
$ pip install sphinx-cacheFrom source
$ git clone https://github.com/useblocks/sphinx-cache
$ cd sphinx-cache
$ pip install .Configuration
All configurations take place in your project’s conf.py file.
Activation
Add sphinx_cache to the extensions list.
extensions = ["sphinx_cache",]Options
All configuration options start with the prefix cache_ for Sphinx-Cache.
cache_store_path
The cache_store_path option specifies the directory path where you want to save the doctree cache files.
Default: .cache/
cache_doctree_path
The cache_doctree_path option specifies the directory path of the doctree folder.
Default: _build/.doctrees
1 maintainer
Metadata
1 maintainer
Release files for sphinx-cache 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_cache-0.0.1.tar.gz | 4.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_cache-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.0 kB
Release files / sphinx_cache-0.0.1.tar.gz
| Download URL | sphinx_cache-0.0.1.tar.gz |
|---|---|
| Size | 4.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
983d0c1f76f221cab4782f0a199517e4b198f17ceef7257d4036099c560d99fc
|
|
BLAKE2b-256 checksum How to use checksums |
42888f8511c9f24dbf55b2b5bc80e95a753574823cdc1ad2297ffe57da66573a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / sphinx_cache-0.0.1-py3-none-any.whl
| Download URL | sphinx_cache-0.0.1-py3-none-any.whl |
|---|---|
| Size | 5.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
da63fc588f0a0d902d6997e568d1f679a212d34219dc4381224aead0d5bd15f4
|
|
BLAKE2b-256 checksum How to use checksums |
0e86aa1f1630dfb7156d2f9d4e23461dfb1f1f7a357697099433396cea551c4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
