Skip to main content

Open Python docs in the browser.

Project description

python-doc

Open Python docs in the browser.

Background

  • Search engines still take you to Python 2.7 docs, and not the docs for the Python version you're using.
  • python-doc installs all docs on your machine, so you don't need an internet connection to view them.
  • You can also ask python-doc to take you to the docs.python.org website.

Inspired by rustup doc which opens docs associated with the installed Rust toolchain in your browser.

Installation

You can simply use pip to install python-doc:

$ pip install python-doc

Usage

You can open the main docs page for your Python version using:

$ python-doc

You can also go to a specific module's doc 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-doc-2020.10.1.tar.gz (35.5 MB view hashes)

Uploaded source

Built Distribution

python_doc-2020.10.1-py2.py3-none-any.whl (39.7 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page