Sphinx extension for documentation in the Scrapy ecosystem.
Features
Automatic configuration of intersphinx for Python and Scrapy.
Ready-to-use, easy-to-enable configuration for the following packages of the Scrapy ecosystem is also available:
twisted (and twistedapi)To automatically configure intersphinx for any of those packages if installed, add to your conf.py file:
scrapy_intersphinx_enable_installed = TrueYou can also enable or disable the automatic intersphinx configuration of packages manually:
scrapy_intersphinx_enable = [ "parsel", "w3lib", ] scrapy_intersphinx_disable = [ "scrapy", ]Automatic configuration of Sphinx roles of the Scrapy documentation, so that you can easily link to Scrapy settings, request metadata keys, signals and commands:
:setting:`BOT_NAME` :setting:`LOG_LEVEL <scrapy:LOG_LEVEL>` :reqmeta:`download_slot` :signal:`spider_opened` :command:`crawl`
Setup
Install:
pip install sphinx-scrapyAdd to your conf.py:
extensions = [ "sphinx.ext.intersphinx", "sphinx_scrapy", ]
Release notes
See Release notes for a list of releases and their changes.
1 maintainer
Release files for sphinx-scrapy 0.6.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_scrapy-0.6.1.tar.gz | 5.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_scrapy-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.6 kB
Release files / sphinx_scrapy-0.6.1.tar.gz
| Download URL | sphinx_scrapy-0.6.1.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e967a3cc93440f166de7009fff977c8a713881a3b8e308fb4c72e7b1208c90d9
|
|
BLAKE2b-256 checksum How to use checksums |
f10a5de3cabceb5bfdfdb7eeb84022d7bfe8305fc5f33d2b8cc04bba48ec6ed9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 16, 2025.
Transparency logRelease files / sphinx_scrapy-0.6.1-py3-none-any.whl
| Download URL | sphinx_scrapy-0.6.1-py3-none-any.whl |
|---|---|
| Size | 5.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ebb0e3a5d0b7c8058aef86b4efc07cf44e59377963cdc35c30e29f6ec01b6051
|
|
BLAKE2b-256 checksum How to use checksums |
a0e0c758e45150004ebd32029ffb97d56d093cff2ae85f88b437fda11e25b85a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 16, 2025.
Transparency log
