Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_cache-0.0.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

sphinx_cache-0.0.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_cache-0.0.1.tar.gz.

File metadata

  • Download URL: sphinx_cache-0.0.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for sphinx_cache-0.0.1.tar.gz
Algorithm Hash digest
SHA256 983d0c1f76f221cab4782f0a199517e4b198f17ceef7257d4036099c560d99fc
MD5 e052cebb3992b915321ea186d81b34d9
BLAKE2b-256 42888f8511c9f24dbf55b2b5bc80e95a753574823cdc1ad2297ffe57da66573a

See more details on using hashes here.

File details

Details for the file sphinx_cache-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_cache-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 da63fc588f0a0d902d6997e568d1f679a212d34219dc4381224aead0d5bd15f4
MD5 cd07ad10d7dd5e0769b6b4ac773b7a69
BLAKE2b-256 0e86aa1f1630dfb7156d2f9d4e23461dfb1f1f7a357697099433396cea551c4e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page