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

Python: scrap full documentation (instead of library reference only) #696

Open
ngrilly opened this issue Oct 20, 2017 · 2 comments
Open

Python: scrap full documentation (instead of library reference only) #696

ngrilly opened this issue Oct 20, 2017 · 2 comments

Comments

@ngrilly
Copy link

@ngrilly ngrilly commented Oct 20, 2017

Currently, DevDocs only scraps Python library reference rooted at https://docs.python.org/2/library/index.html.

It would be great to scrap the full documentation rooted at https://docs.python.org/2/.

@Alex131089
Copy link

@Alex131089 Alex131089 commented Jul 23, 2018

I agree, the same for Python 3.
For example, the global keywork is only documented in the Language reference at https://docs.python.org/3/reference/simple_stmts.html#the-global-statement
I guess at least the /reference/ should be added.

Would changing

self.root_path = 'library/index.html'
options[:only_patterns] = [/\Alibrary\//]

by

options[:only_patterns] = [/\Alibrary\//, /\Areference\//]

or

self.root_path = 'index.html'
options[:only_patterns] = [/\Aindex\.html/, /\Alibrary\//, /\Areference\//]

in https://github.com/freeCodeCamp/devdocs/blob/master/lib/docs/scrapers/python.rb be enough ?

@godlygeek
Copy link

@godlygeek godlygeek commented Apr 17, 2019

This also means that the Python C API documentation isn't included, because it's under https://docs.python.org/3/c-api/

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

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.