Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Building settings list from docs #1220

Merged

Conversation

@eliasdorneles
Copy link
Member

@eliasdorneles eliasdorneles commented May 9, 2015

Hey, folks!

So, this PR intends to fix #518, changing the scrapydocs extension to do the following:

  • collect all setting definitions in the documentation in the env variable
  • adds a directive settingslist which will render a list of settings defined anywhere in the documentation except in the current document (I added this restriction to make it less verbose, the complete list is too big).

Does this look good?

@pablohoffman
Copy link
Member

@pablohoffman pablohoffman commented May 11, 2015

It's looking good, just two suggestions:

  1. can we show the list sorted alphabetically?
  2. can we put them in a proper HTML <ul> list?. Right now each one is on a separate paragraph <p> and that makes the rendering a bit awkward.
@eliasdorneles
Copy link
Member Author

@eliasdorneles eliasdorneles commented May 12, 2015

pablohoffman added a commit that referenced this pull request May 13, 2015
…m-docs

Building settings list from docs
@pablohoffman pablohoffman merged commit 65aa9cc into scrapy:master May 13, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@pablohoffman
Copy link
Member

@pablohoffman pablohoffman commented May 13, 2015

good job @eliasdorneles !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

2 participants
You can’t perform that action at this time.