Sphinx extension for storing and restoring `.doctree` cache.
Project description
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-cache
From 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_cache-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da63fc588f0a0d902d6997e568d1f679a212d34219dc4381224aead0d5bd15f4 |
|
MD5 | cd07ad10d7dd5e0769b6b4ac773b7a69 |
|
BLAKE2b-256 | 0e86aa1f1630dfb7156d2f9d4e23461dfb1f1f7a357697099433396cea551c4e |