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

docs/autogen_shortcuts.py: support Python 3.8...

docs/autogen_shortcuts.py: support Python 3.8 In 64e72a955 (Restore shortcuts in documentation, define identifiers, 2023-01-08), some typing annotations were added to docs/autogen_shortcuts.py using the builtin container type 'list'. This feature is only available starting in Python 3.9 [1], but setup.cfg lists Python 3.8 as the earliest supported Python version. This leads to a failing documentation build in a Python 3.8 virtual environment. Fix this by using the capitalized name 'List' from the 'typing' module to keep Python 3.8 compatibility. [1] https://docs.python.org/3/whatsnew/3.9.html#type-hinting-generics-in-standard-collections

Michał Krassowski - - Load All Authors

File last commit:

r27796:5bb0259a


                r28181:2c9a826a

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"