Jump to content
  • Advertisement
Sign in to follow this  
Shane Francis

How can I download a modules documentation?

This topic is 750 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

How can I download a modules documentation? I need to be able to download it to my phone and transfer it to my pc. I don't want to check it up online everytime.

Share this post


Link to post
Share on other sites
Advertisement

That depends on what the author of that module does. Some don't provide any, many provide some online, and only a few also provide means to get documentation for offline browsing.

 

For Python, program documentation is often literally inside the Python files (first statement of a class or function), eg, from "socks.py" in the standard library:

def set_default_proxy(proxy_type=None, addr=None, port=None, rdns=True, username=None, password=None):
    """
    set_default_proxy(proxy_type, addr[, port[, rdns[, username, password]]])

    Sets a default proxy which all further socksocket objects will use,
    unless explicitly changed. All parameters are as for socket.set_proxy().
    """
    socksocket.default_proxy = (proxy_type, addr, port, rdns,
                                username.encode() if username else None,
                                password.encode() if password else None)

Below the "def", there is a string describing the function. Maybe your third-party modules have this too, just open their .py files, and have a look.

 

Otherwise, maybe you can convince a browser program to download the documentation for offline browsing. This functionality used to exist, not sure this is still done.

Finally, you could consider mirroring a part of the site. Not all sites allow this though, you'd have to check that first.

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!