| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,35 @@ | |||
| 1 | + .. _builtins-index: | ||
| 2 | + | ||
| 3 | + ############################## | ||
| 4 | + Python built-ins reference | ||
| 5 | + ############################## | ||
| 6 | + | ||
| 7 | + Python comes with a number of built-in functions and classes. | ||
| 8 | + | ||
| 9 | + The built-in classes include data types that would normally be considered part | ||
| 10 | + of the "core" of a language, such as numbers and lists. For these types, the | ||
| 11 | + Python language core defines the form of literals and places some constraints | ||
| 12 | + on their semantics, but does not fully define the semantics. | ||
| 13 | + | ||
| 14 | + The built-ins also include functions and exceptions --- objects that can | ||
| 15 | + be used by all Python code without the need of an :keyword:`import` statement. | ||
| 16 | + Some of these are defined by the core language, but many are not essential for | ||
| 17 | + the core semantics and are only described here. | ||
| 18 | + | ||
| 19 | + .. seealso:: | ||
| 20 | + | ||
| 21 | + In addition to the built-ins, Python provides an extensive importable | ||
| 22 | + standard library, see :ref:`library-index`. | ||
| 23 | + | ||
| 24 | + .. We don't use :numbered: option for the TOC below as it enforces | ||
| 25 | + numbered sections for the entire builtin docs. If desired, | ||
| 26 | + :numbered: can be enabled on a per-page basis. | ||
| 27 | + .. toctree:: | ||
| 28 | + :maxdepth: 2 | ||
| 29 | + | ||
| 30 | + stdtypes.rst | ||
| 31 | + constants.rst | ||
| 32 | + functions.rst | ||
| 33 | + exceptions.rst | ||
| 34 | + threadsafety.rst | ||
| 35 | + time-complexity.rst | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -44,6 +44,7 @@ | |||
| 44 | 44 | 'sphinx_linklint.ext', | |
| 45 | 45 | 'notfound.extension', | |
| 46 | 46 | 'sphinxext.opengraph', | |
| 47 | + 'sphinxext.rediraffe', | ||
| 47 | 48 | 'sphinxcontrib.rsvgconverter', | |
| 48 | 49 | ) | |
| 49 | 50 | for optional_ext in _OPTIONAL_EXTENSIONS: | |
@@ -361,7 +362,13 @@ | |||
| 361 | 362 | # Grouping the document tree into LaTeX files. List of tuples | |
| 362 | 363 | # (source start file, target name, title, author, document class [howto/manual]). | |
| 363 | 364 | latex_documents = [ | |
| 364 | - ('c-api/index', 'c-api.tex', 'The Python/C API', _doc_authors, 'manual'), | ||
| 365 | + ( | ||
| 366 | + 'c-api/index', | ||
| 367 | + 'c-api.tex', | ||
| 368 | + 'The Python/C API', | ||
| 369 | + _doc_authors, | ||
| 370 | + 'manual', | ||
| 371 | + ), | ||
| 365 | 372 | ( | |
| 366 | 373 | 'extending/index', | |
| 367 | 374 | 'extending.tex', | |
@@ -376,6 +383,13 @@ | |||
| 376 | 383 | _doc_authors, | |
| 377 | 384 | 'manual', | |
| 378 | 385 | ), | |
| 386 | + ( | ||
| 387 | + 'builtins/index', | ||
| 388 | + 'builtins.tex', | ||
| 389 | + 'Python Built-ins Reference', | ||
| 390 | + _doc_authors, | ||
| 391 | + 'manual', | ||
| 392 | + ), | ||
| 379 | 393 | ( | |
| 380 | 394 | 'library/index', | |
| 381 | 395 | 'library.tex', | |
@@ -608,3 +622,16 @@ | |||
| 608 | 622 | '<meta property="og:image:width" content="200">', | |
| 609 | 623 | '<meta property="og:image:height" content="200">', | |
| 610 | 624 | ) | |
| 625 | + | ||
| 626 | + # Options for sphinxext-rediraffe | ||
| 627 | + # ------------------------------- | ||
| 628 | + | ||
| 629 | + rediraffe_redirects = { | ||
| 630 | + # Splitting builtins from library | ||
| 631 | + "library/functions.rst": "builtins/functions.rst", | ||
| 632 | + "library/stdtypes.rst": "builtins/stdtypes.rst", | ||
| 633 | + "library/constants.rst": "builtins/constants.rst", | ||
| 634 | + "library/exceptions.rst": "builtins/exceptions.rst", | ||
| 635 | + "library/threadsafety.rst": "builtins/threadsafety.rst", | ||
| 636 | + "library/time-complexity.rst": "builtins/time-complexity.rst", | ||
| 637 | + } | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -8,6 +8,7 @@ | |||
| 8 | 8 | tutorial/index.rst | |
| 9 | 9 | using/index.rst | |
| 10 | 10 | reference/index.rst | |
| 11 | + builtins/index.rst | ||
| 11 | 12 | library/index.rst | |
| 12 | 13 | extending/index.rst | |
| 13 | 14 | c-api/index.rst | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,9 +16,10 @@ underlying operating system supports this feature. | |||
| 16 | 16 | ||
| 17 | 17 | This document assumes basic knowledge about C and Python. For an informal | |
| 18 | 18 | introduction to Python, see :ref:`tutorial-index`. :ref:`reference-index` | |
| 19 | - gives a more formal definition of the language. :ref:`library-index` documents | ||
| 20 | - the existing object types, functions and modules (both built-in and written in | ||
| 21 | - Python) that give the language its wide application range. | ||
| 19 | + gives a more formal definition of the language. :ref:`builtins-index` documents | ||
| 20 | + the built-in functions and object types, and :ref:`library-index` documents the | ||
| 21 | + modules (both built-in and written in Python) that give the language its wide | ||
| 22 | + application range. | ||
| 22 | 23 | ||
| 23 | 24 | For a detailed description of the whole Python/C API, see the separate | |
| 24 | 25 | :ref:`c-api-index`. | |
| Back | FazBrowse Home | New Git URL |
0 commit comments