af624ef414
There exists an inconsistency between the code (line 37 - 38) and the output 'quotes.json' (line 56 - 68).
Note that even though according to line 53 - 54 'quotes.json' is "reformatted here for better readability", it cannot explain why the "author" field precedes the "text" field.
Intended output for the code BEFORE change:
[{
"text": "\u201cThe person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.\u201d",
"author": "Jane Austen"
},
{
"text": "\u201cOutside of a dog, a book is man's best friend. Inside of a dog it's too dark to read.\u201d",
"author": "Groucho Marx"
},
{
"text": "\u201cA day without sunshine is like, you know, night.\u201d",
"author": "Steve Martin"
},
...]
Intended output for the code After change (the inconsistency is fixed):
[{
"author": "Jane Austen",
"text": "\u201cThe person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.\u201d"
},
{
"author": "Groucho Marx",
"text": "\u201cOutside of a dog, a book is man's best friend. Inside of a dog it's too dark to read.\u201d"
},
{
"author": "Steve Martin",
"text": "\u201cA day without sunshine is like, you know, night.\u201d"
},
...]
|
||
|---|---|---|
| .. | ||
| _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