upstream/ipython Files · IPython/utils/docs.py

Allow to dispatch getting documentation on objects...

Allow to dispatch getting documentation on objects Base for , so that object can be queried for documentation on their fields/properties. Typically this allows the following, to extend the doc documentation when requesting information on a field. In [1]: class DictLike: ...: def __getitem__(self, k): ...: if k.startswith('f'): ...: return "documentation for k" ...: else: ...: raise KeyError ...: ...: class Bar: ...: __custom_documentations__ = DictLike() ...: ...: faz = 1 ...: ...: ...: @property ...: def foo(self): ...: return 1 ...: b = Bar() In [2]: b.faz?

Michał Krassowski - - Load All Authors

File last commit:

r27796:5bb0259a


                r28195:fc872d6c

Download file

             docs.py
        
                    3 lines
            
             | 86 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / docs.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        krassowski
    
Improve type hinting and documentation

              r27778
            
      import os

      GENERATING_DOCUMENTATION = os.environ.get("IN_SPHINX_RUN", None) == "True"

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

krassowski Improve type hinting and documentation	r27778	import os

		GENERATING_DOCUMENTATION = os.environ.get("IN_SPHINX_RUN", None) == "True"