Source

sphinx-web-support / doc / web / storagebackends.rst

Storage Backends

To create a custom storage backend you will need to subclass the :class:`~StorageBackend` class. Then create an instance of the new class and pass that as the storage keyword argument when you create the :class:`~sphinx.websupport.WebSupport` object:

support = Websupport(srcdir=srcdir,
                     builddir=builddir,
                     storage=MyStorage())

For more information about creating a custom storage backend, please see the documentation of the :class:`StorageBackend` class below.

Defines an interface for storage backends.

StorageBackend Methods