Sphinx-Cache Docs
=================
Sphinx-Cache is a `Sphinx <https://www.sphinx-doc.org>`_ extension for storing and restoring the `.doctrees` cache.
.. _install:
Installation
------------
We recommend using the latest version of Python. Sphinx-Cache supports Python 3.6 and newer versions.
**Using pip**
.. code-block:: bash
$ pip install sphinx-cache
**From source**
.. code-block:: bash
$ git clone https://github.com/useblocks/sphinx-cache
$ cd sphinx-cache
$ pip install .
.. _config:
Configuration
-------------
All configurations take place in your project's ``conf.py`` file.
Activation
**********
Add **sphinx_cache** to the extensions list.
.. code-block:: python
extensions = ["sphinx_cache",]
Options
*******
All configuration options start with the prefix ``cache_`` for **Sphinx-Cache**.
.. _cache_store_path:
cache_store_path
++++++++++++++++
The ``cache_store_path`` option specifies the directory path where you want to save the doctree cache files.
.. note::
The path should be specified as a relative path relative to the directory of the ``conf.py`` file.
For example: :code:`cache_store_path = '.cache/'`.
Default: ``.cache/``
.. _cache_doctree_path:
cache_doctree_path
++++++++++++++++++
The ``cache_doctree_path`` option specifies the directory path of the doctree folder.
.. note::
* The path should be specified as a relative path relative to the directory of the ``conf.py`` file.
For example: ``cache_doctree_path = '_build/.doctrees'``.
* We use the value provided for the ``cache_doctree_path`` as directory for storing pickled doctrees.
If you don't specify the value for the ``cache_doctree_path`` in the ``conf.py`` file, we use the default
value for the ``cache_doctree_path`` (i.e. ``_build/.doctrees``).
Default: ``_build/.doctrees``
Raw data
{
"_id": null,
"home_page": "https://github.com/useblocks/sphinx-cache",
"name": "sphinx-cache",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "team useblocks",
"author_email": "info@useblocks.com",
"download_url": "https://files.pythonhosted.org/packages/42/88/8f8511c9f24dbf55b2b5bc80e95a753574823cdc1ad2297ffe57da66573a/sphinx_cache-0.0.1.tar.gz",
"platform": null,
"description": "Sphinx-Cache Docs\n=================\n\nSphinx-Cache is a `Sphinx <https://www.sphinx-doc.org>`_ extension for storing and restoring the `.doctrees` cache.\n\n.. _install:\n\nInstallation\n------------\nWe recommend using the latest version of Python. Sphinx-Cache supports Python 3.6 and newer versions.\n\n**Using pip**\n\n.. code-block:: bash\n\n $ pip install sphinx-cache\n\n**From source**\n\n.. code-block:: bash\n\n $ git clone https://github.com/useblocks/sphinx-cache\n $ cd sphinx-cache\n $ pip install .\n\n.. _config:\n\nConfiguration\n-------------\n\nAll configurations take place in your project's ``conf.py`` file.\n\nActivation\n**********\n\nAdd **sphinx_cache** to the extensions list.\n\n.. code-block:: python\n\n extensions = [\"sphinx_cache\",]\n\nOptions\n*******\n\nAll configuration options start with the prefix ``cache_`` for **Sphinx-Cache**.\n\n.. _cache_store_path:\n\ncache_store_path\n++++++++++++++++\n\nThe ``cache_store_path`` option specifies the directory path where you want to save the doctree cache files.\n\n.. note::\n\n The path should be specified as a relative path relative to the directory of the ``conf.py`` file.\n For example: :code:`cache_store_path = '.cache/'`.\n\nDefault: ``.cache/``\n\n.. _cache_doctree_path:\n\ncache_doctree_path\n++++++++++++++++++\n\nThe ``cache_doctree_path`` option specifies the directory path of the doctree folder.\n\n.. note::\n\n * The path should be specified as a relative path relative to the directory of the ``conf.py`` file.\n For example: ``cache_doctree_path = '_build/.doctrees'``.\n * We use the value provided for the ``cache_doctree_path`` as directory for storing pickled doctrees.\n If you don't specify the value for the ``cache_doctree_path`` in the ``conf.py`` file, we use the default\n value for the ``cache_doctree_path`` (i.e. ``_build/.doctrees``).\n\nDefault: ``_build/.doctrees``\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Sphinx extension for storing and restoring `.doctree` cache.",
"version": "0.0.1",
"project_urls": {
"Documentation": "http://sphinx-cache.useblocks.com",
"Homepage": "https://github.com/useblocks/sphinx-cache",
"Repository": "https://github.com/useblocks/sphinx-cache"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e86aa1f1630dfb7156d2f9d4e23461dfb1f1f7a357697099433396cea551c4e",
"md5": "cd07ad10d7dd5e0769b6b4ac773b7a69",
"sha256": "da63fc588f0a0d902d6997e568d1f679a212d34219dc4381224aead0d5bd15f4"
},
"downloads": -1,
"filename": "sphinx_cache-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd07ad10d7dd5e0769b6b4ac773b7a69",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0,<4.0",
"size": 5348,
"upload_time": "2023-08-29T13:25:21",
"upload_time_iso_8601": "2023-08-29T13:25:21.919162Z",
"url": "https://files.pythonhosted.org/packages/0e/86/aa1f1630dfb7156d2f9d4e23461dfb1f1f7a357697099433396cea551c4e/sphinx_cache-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42888f8511c9f24dbf55b2b5bc80e95a753574823cdc1ad2297ffe57da66573a",
"md5": "e052cebb3992b915321ea186d81b34d9",
"sha256": "983d0c1f76f221cab4782f0a199517e4b198f17ceef7257d4036099c560d99fc"
},
"downloads": -1,
"filename": "sphinx_cache-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e052cebb3992b915321ea186d81b34d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0,<4.0",
"size": 4631,
"upload_time": "2023-08-29T13:25:23",
"upload_time_iso_8601": "2023-08-29T13:25:23.969709Z",
"url": "https://files.pythonhosted.org/packages/42/88/8f8511c9f24dbf55b2b5bc80e95a753574823cdc1ad2297ffe57da66573a/sphinx_cache-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-29 13:25:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "useblocks",
"github_project": "sphinx-cache",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-cache"
}
JSON
