d29bec60d7
* Upgrade PyPy for CI, and test both 3.5 (oldest) and 3.6 (newest)
* Log a detailed error message to discover why MockServer is not working
* Go for all lines!
* Disable tests based on mitmproxy while running on PyPy
* Fix test_get_func_args for PyPy 3.6+
* Make testPayloadDefaultCiphers work regardless of OpenSSL default ciphers
* Crossing fingers…
* Rename: testPayloadDefaultCiphers → testPayloadDisabledCipher
* Test the PyPy version currently documented as the minimum required version
* Fix the PYPY_VERSION tag
* Update the documentation about supported PyPy versions
* Also test the latest 3.5 Python version with PyPy
* Fix the PYPY_VERSION value for the latest 3.5 version
* Use pinned dependencies for asyncio and PyPy tests against oldest supported Python versions
* Fix PyPy installation for the pypy3-pinned Tox environment
* Try installing Cython
* Maybe PyPy requires lxml 3.6.0?
* install.rst: minor clarification
* lxml 4.0.0 is required on PyPy
* Require setuptools 18.5+
* Revert "Require setuptools 18.5+"
This reverts commit
|
||
|---|---|---|
| .. | ||
| _ext | ||
| _static | ||
| _templates | ||
| _tests | ||
| intro | ||
| topics | ||
| utils | ||
| Makefile | ||
| README.rst | ||
| conf.py | ||
| conftest.py | ||
| contributing.rst | ||
| faq.rst | ||
| index.rst | ||
| news.rst | ||
| requirements.txt | ||
| versioning.rst | ||
README.rst
| orphan: |
|---|
Scrapy documentation quick start guide
This file provides a quick guide on how to compile the Scrapy documentation.
Setup the environment
To compile the documentation you need Sphinx Python library. To install it and all its dependencies run the following command from this dir
pip install -r requirements.txt
Compile the documentation
To compile the documentation (to classic HTML output) run the following command from this dir:
make html
Documentation will be generated (in HTML format) inside the build/html dir.
View the documentation
To view the documentation run the following command:
make htmlview
This command will fire up your default browser and open the main page of your (previously generated) HTML documentation.
Start over
To cleanup all generated documentation files and start from scratch run:
make clean
Keep in mind that this command won't touch any documentation source files.
Recreating documentation on the fly
There is a way to recreate the doc automatically when you make changes, you need to install watchdog (pip install watchdog) and then use:
make watch
Alternative method using tox
To compile the documentation to HTML run the following command:
tox -e docs
Documentation will be generated (in HTML format) inside the .tox/docs/tmp/html dir.