Open Python docs in the browser.
Project description
python-doc
Open Python docs in the browser.
Why?
- Google still shows Python 2.7 doc links in search results.
- Inspiration from
rustup doc
which opens docs associated with the installed Rust toolchain. - You don't need an internet connection to view docs as
python-doc
installs them on your machine.
Installation
You can simply use pip
to install python-doc
:
$ pip install python-doc
Usage
You can open the main page associated with your Python version using:
$ python-doc
You can also go to a specific module's page using the -m
option:
$ python-doc -m os
If you want to see the docs for a different Python version than your own, you can use the -py
option:
$ python-doc -m os -py 3.6
To open docs on the docs.python.org website, you can use the -w
option:
$ python-doc -m os -py 3.6 -w
To look at all the available options, you can check out the help using:
$ python-doc --help
Versioning
python-doc
uses Calendar Versioning. For the available versions, see the tags on the GitHub repository.
License
This project is licensed under the Apache License, see the LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_doc-2020.9.30a2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f42d345a1b3acc98d3927a36386f96cc8d83e408c1f2e28c239630dcb286992 |
|
MD5 | edd7d55ad9fd5f7e496667e7a61b8fdd |
|
BLAKE2b-256 | 982b1ea950c9129aa73f229972168f5ca0fe000f716807d620cac8eca8873e50 |