Discussion:
[Tutor] python 3.4 documentation
Alex Kleider
2015-06-14 18:56:15 UTC
Permalink
I'm using python 3.4 on an ubuntu 14.4 LTS OS and frequently find myself
'off line'.
I'd like to download the standard library documentation to have at hand
on my hard drive.
I tried
prompt> wget -r https://docs.python.org/3/library/index.html
but links appear to be broken.
I'd be grateful for advice as to the way to do this.
Thanks in advance.
Alex
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Hilton Fernandes
2015-06-14 19:36:15 UTC
Permalink
Hello, Alex !

I believe that maybe in the page
https://docs.python.org/3/download.html

you will find what you're looking for.

All the best,
Hilton
Post by Alex Kleider
I'm using python 3.4 on an ubuntu 14.4 LTS OS and frequently find myself
'off line'.
I'd like to download the standard library documentation to have at hand on
my hard drive.
I tried
prompt> wget -r https://docs.python.org/3/library/index.html
but links appear to be broken.
I'd be grateful for advice as to the way to do this.
Thanks in advance.
Alex
_______________________________________________
https://mail.python.org/mailman/listinfo/tutor
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Alex Kleider
2015-06-14 22:50:38 UTC
Permalink
Post by Hilton Fernandes
Hello, Alex !
I believe that maybe in the page
https://docs.python.org/3/download.html
Thank you Hilton, Laura and Peter for pointing me in the right
direction.
Being 'off line' will no longer be such a hardship.


_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Laura Creighton
2015-06-15 00:13:04 UTC
Permalink
Post by Alex Kleider
Post by Hilton Fernandes
Hello, Alex !
I believe that maybe in the page
https://docs.python.org/3/download.html
Thank you Hilton, Laura and Peter for pointing me in the right
direction.
Being 'off line' will no longer be such a hardship.
You are most welcome, but I want to go fix this for the next person
who comes along. Where did you find the bad link? Or, if you just
assumed that the one you tried would work, what can we do to keep the
next person from assuming the same thing?

Laura

_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Alex Kleider
2015-06-15 02:59:00 UTC
Permalink
Post by Laura Creighton
Post by Alex Kleider
Post by Hilton Fernandes
Hello, Alex !
I believe that maybe in the page
https://docs.python.org/3/download.html
Thank you Hilton, Laura and Peter for pointing me in the right
direction.
Being 'off line' will no longer be such a hardship.
You are most welcome, but I want to go fix this for the next person
who comes along. Where did you find the bad link? Or, if you just
assumed that the one you tried would work, what can we do to keep the
next person from assuming the same thing?
Laura
Here's the command I initially used:
prompt> wget -r https://docs.python.org/3/library/index.html

The directory that resulted seemed to have everything but when I tried
to use links, none worked.
I have since deleted the above and downloaded (and 'untared') as
follows:
prompt> tar -xvjf python-3.4.3-docs-html.tar.bz2
All is now well.

I could repeat the (wget) process and give you more detailed information
if that would be helpful.
(Let me know.)
Alex
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Laura Creighton
2015-06-15 10:34:22 UTC
Permalink
Post by Alex Kleider
Post by Laura Creighton
Post by Alex Kleider
Post by Hilton Fernandes
Hello, Alex !
I believe that maybe in the page
https://docs.python.org/3/download.html
Thank you Hilton, Laura and Peter for pointing me in the right
direction.
Being 'off line' will no longer be such a hardship.
You are most welcome, but I want to go fix this for the next person
who comes along. Where did you find the bad link? Or, if you just
assumed that the one you tried would work, what can we do to keep the
next person from assuming the same thing?
Laura
prompt> wget -r https://docs.python.org/3/library/index.html
The directory that resulted seemed to have everything but when I tried
to use links, none worked.
I have since deleted the above and downloaded (and 'untared') as
prompt> tar -xvjf python-3.4.3-docs-html.tar.bz2
All is now well.
I could repeat the (wget) process and give you more detailed information
if that would be helpful.
(Let me know.)
Alex
Yes please.

Laura

_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Steven D'Aprano
2015-06-15 03:46:08 UTC
Permalink
Post by Laura Creighton
Post by Alex Kleider
Post by Hilton Fernandes
Hello, Alex !
I believe that maybe in the page
https://docs.python.org/3/download.html
Thank you Hilton, Laura and Peter for pointing me in the right
direction.
Being 'off line' will no longer be such a hardship.
You are most welcome, but I want to go fix this for the next person
who comes along. Where did you find the bad link? Or, if you just
assumed that the one you tried would work, what can we do to keep the
next person from assuming the same thing?
I think that what Alex means is that after downloading the docs via
wget, the links were broken in his local copy.

I'm not sure if that's to be expected or not. If the web pages are
static, then you should be able to download with wget and have it work
locally, but perhaps not if the webserver is doing something funny, or
if Alex got the wget command wrong.
--
Steve
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Peter Otten
2015-06-14 19:39:27 UTC
Permalink
Post by Alex Kleider
I'm using python 3.4 on an ubuntu 14.4 LTS OS and frequently find myself
'off line'.
I'd like to download the standard library documentation to have at hand
on my hard drive.
I tried
prompt> wget -r https://docs.python.org/3/library/index.html
but links appear to be broken.
I'd be grateful for advice as to the way to do this.
Thanks in advance.
Go here

https://docs.python.org/3/download.html

and download an archived version with e. g.

$ wget https://docs.python.org/3/archives/python-3.4.3-docs-html.tar.bz2

or use

$ sudo apt-get install python3-doc

to install the documentation that comes with Ubuntu.

_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Laura Creighton
2015-06-14 21:52:45 UTC
Permalink
This is working for me
https://docs.python.org/3.3/download.html

Where do you find the broken link? That needs fixing.

Laura

_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Steven D'Aprano
2015-06-15 03:49:44 UTC
Permalink
Post by Alex Kleider
I'm using python 3.4 on an ubuntu 14.4 LTS OS and frequently find myself
'off line'.
The Python interactive interpreter comes with a powerful interactive
help system. At the Python prompt, you can enter:

help()

help("keyword") # e.g. "raise"

help(any_object)


to get help and documentation.
--
Steve
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Alex Kleider
2015-06-16 02:59:05 UTC
Permalink
Post by Steven D'Aprano
The Python interactive interpreter comes with a powerful interactive
help()
help("keyword") # e.g. "raise"
help(any_object)
to get help and documentation.
Thank you for this tip. I sort of was aware of it but had no idea
of how much help was there. I certainly had no idea that modules
were documented as well:

***@t61p:~$ python3
Python 3.4.0 (default, Apr 11 2014, 13:05:18)
[GCC 4.8.2] on linux
Type "help", "copyright", "credits" or "license" for more information.
Post by Steven D'Aprano
help('key words')
no Python documentation found for 'key words'
Post by Steven D'Aprano
help('keywords')
Here is a list of the Python keywords. Enter any keyword to get more
help.

False def if raise
None del import return
True elif in try
and else is while
as except lambda with
assert finally nonlocal yield
break for not
class from or
continue global pass
Post by Steven D'Aprano
import csv
help('csv')
...and documentation of the modules appears in the pager!
_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/listinfo/tutor
Ben Finney
2015-06-16 03:09:28 UTC
Permalink
Post by Alex Kleider
import csv
help('csv')
...and documentation of the modules appears in the pager!
Yes. This is positive reinforcement for writing meaningful, standardised
docstrings for every code object (module, class, function): the
docstring is automatically available for browsing at the interactive
prompt, in the context of the object itself.

The flip side is: the documentation available there is only as good as
the documentation that has been written as a docstring for that object.

Encourage authors of libraries you use to maintain and improve their
docstrings :-)
--
\ “It's my belief we developed language because of our deep inner |
`\ need to complain.” —Jane Wagner, via Lily Tomlin |
_o__) |
Ben Finney

_______________________________________________
Tutor maillist - ***@python.org
To unsubscribe or change subscription options:
https://mail.python.org/mailman/li
Continue reading on narkive:
Loading...