Skip to content
/ gmtd Public

Give Me the Docs finds the docs for Python packages so you don't have to.

License

Notifications You must be signed in to change notification settings

bsoyka/gmtd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Give Me the Docs

Give Me the Docs finds the docs for Python packages so you don't have to.

$ gmtd numpy
Found documentation for numpy:

    - https://numpy.org/doc/1.21
    - https://www.numpy.org

Downloads Supported Versions License Version

Installation

Give Me the Docs is available on PyPI:

$ pip install gmtd

Give Me the Docs officially supports Python 3.8+.

API Reference

gmtd.get_documentation(package_name)

Gets the documentation URL for a package.

Args

  • package (str): The name of the package to get documentation for.

Returns:

(List[str]): A list of possible documentation URLs for the package, ordered from most to least likely to be official documentation.

Raises:

  • PackageNotFoundError: If the package is not installed.

About

Give Me the Docs finds the docs for Python packages so you don't have to.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Languages