summaryrefslogtreecommitdiffstats
path: root/Doc/extending
Commit message (Collapse)AuthorAgeFilesLines
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * bpo-40204: Fix reference to terms in the doc (GH-21865) Sphinx 3 requires to refer to terms with the exact case. For example, fix the Sphinx 3 warning: Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case sensitive match.made a reference to loader instead. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a) (cherry picked from commit 8f88190af529543c84d5dc78f19abbfd73335cf4)
* bpo-40279: Add some error-handling to the module initialisation docs example ↵Miss Islington (bot)2020-04-251-3/+11
| | | | | | | (GH-19705) (GH-19710) (cherry picked from commit d4f3923d5901ef1ccdbe6ad6c5a753af90832a0f) Co-authored-by: Cajetan Rodrigues <caje731@gmail.com>
* [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003)Serhiy Storchaka2019-10-301-1/+1
| | | | | Also fix some other formatting. (cherry picked from commit e835b31d2b212c3c7820364398979cae2a9740b2)
* [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. ↵Serhiy Storchaka2019-10-304-57/+57
| | | | | | | (GH-16950) (GH-16999) Replace all *NULL* with ``NULL``. (cherry picked from commit 25fc088607c855060ed142296dc1bd0125fad1af)
* bpo-38391: Fixing a typo for Py_DECREF (GH-16616)Miss Islington (bot)2019-10-071-1/+1
| | | | | (cherry picked from commit 038503e08ac5b10601b95d5adc2c2cab7be10163) Co-authored-by: Krishna Oza <krishoza15sep@gmail.com>
* bpo-26868: Fix example usage of PyModule_AddObject. (GH-15725)Miss Islington (bot)2019-09-122-7/+27
| | | | | | | | | | | | | | | | | | * Add a note to the PyModule_AddObject docs. * Correct example usages of PyModule_AddObject. * Whitespace. * Clean up wording. * 📜🤖 Added by blurb_it. * First code review. * Add < 0 in the tests with PyModule_AddObject (cherry picked from commit 224b8aaa7e8f67f748e8b7b6a4a77a25f6554651) Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
* Doc: Replace the deprecated highlightlang directive by highlight. (#13377)Stéphane Wirtel2019-05-176-8/+8
| | | | highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
* Doc: add the missing ".tp_flags" in type definition (GH-12902)Wu Wei2019-04-221-0/+1
|
* Doc: define PY_SSIZE_T_CLEAN always (GH-12794)Inada Naoki2019-04-132-3/+9
|
* fix typo in doc (#12686)Caleb Marchent2019-04-101-2/+2
|
* bpo-33012: Fix invalid function cast warnings with gcc 8. (GH-6749)Serhiy Storchaka2018-11-271-1/+1
| | | | | | Fix invalid function cast warnings with gcc 8 for method conventions different from METH_NOARGS, METH_O and METH_VARARGS excluding Argument Clinic generated code.
* bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)Serhiy Storchaka2018-10-311-2/+3
|
* bpo-17045: Improve C-API doc for PyTypeObject. (gh-7413)Eric Snow2018-06-141-0/+2
| | | The existing doc had a number of info gaps and was a little hard to use. This patch provides several quick-reference tables as well as examples.
* bpo-33012: Fix invalid function cast warnings with gcc 8 for METH_NOARGS. ↵Siddhesh Poyarekar2018-04-291-1/+1
| | | | | | | | | (GH-6030) METH_NOARGS functions need only a single argument but they are cast into a PyCFunction, which takes two arguments. This triggers an invalid function cast warning in gcc8 due to the argument mismatch. Fix this by adding a dummy unused argument.
* Improve highlighting of some code blocks. (GH-6401)Serhiy Storchaka2018-04-083-9/+15
|
* bpo-33201: Modernize "Extension types" doc (GH-6337)Antoine Pitrou2018-04-073-1025/+1016
| | | | | | | | | * bpo-33201: Modernize "Extension types" doc * Split tutorial and other topics * Some small fixes * Address some review comments * Rename noddy* to custom* and shoddy to sublist * Fix markup
* Make formatting of some return codes conforming to the general style. (#5587)Serhiy Storchaka2018-02-091-2/+2
|
* bpo-25910: Link redirections in docs (#1933)Sanyam Khurana2018-01-202-2/+3
| | | Fixes some redirection links in docs.
* Extending Python Doc minor updates (GH-4518)Emanuele Gaifas2017-11-242-4/+4
| | | | Move footnote markers to be closer to the related terminology: before the end of the sentence, instead of after.
* bpo-31443: Formulate the type slot initialization rules in terms of C99. (#3688)Stefan Krah2017-09-221-10/+3
|
* Fix the indentation in Extending Python code example (GH-3244)Sergey Fedoseev2017-08-301-6/+6
| | | | Code was indented with three spaces. Fixed using four spaces.
* bpo-31095: fix potential crash during GC (GH-2974)INADA Naoki2017-08-241-9/+20
|
* bpo-28315: Improve code examples in docs (GH-1372)UltimateCoder2017-05-031-1/+1
| | | | | | Replace File "<stdin>", line 1, in ? with File "<stdin>", line 1, in <module>
* bpo-29918: Add missed "const" modifiers in C API documentation. (#846)Serhiy Storchaka2017-03-302-6/+6
|
* Issue #28761: The fields name and doc of structures PyMemberDef, PyGetSetDef,Serhiy Storchaka2016-11-221-5/+5
| | | | | PyStructSequence_Field, PyStructSequence_Desc, and wrapperbase are now of type "const char *" rather of "char *".
* Fixed the documentation of the structure PyMethodDef.Serhiy Storchaka2016-11-211-2/+2
|\ | | | | | | The fields ml_name and ml_doc are of type "const char *" rather of "char *".
| * Fixed the documentation of the structure PyMethodDef.Serhiy Storchaka2016-11-211-2/+2
| | | | | | | | The fields ml_name and ml_doc are of type "const char *" rather of "char *".
* | Issue #26638: Merge option warning fixes from 3.5 into 3.6Martin Panter2016-10-301-1/+1
|\ \ | |/
| * Issue #26638: Mask undefined CLI options to defeat new Sphinx warningsMartin Panter2016-10-301-1/+1
| |
* | Issue #18287: PyType_Ready() now checks that tp_name is not NULL.Serhiy Storchaka2016-10-071-1/+3
|\ \ | |/ | | | | Original patch by Niklas Koep.
| * Issue #18287: PyType_Ready() now checks that tp_name is not NULL.Serhiy Storchaka2016-10-071-1/+3
| | | | | | | | Original patch by Niklas Koep.
* | Issue #23710: Merge from 3.5Berker Peksag2016-08-031-5/+9
|\ \ | |/
| * Issue #23710: Update PyObject_HEAD documentationBerker Peksag2016-08-031-5/+9
| | | | | | | | | | | | | | Since PEP 3123, PyObject_HEAD only has one field named ob_base. Users now need to use the Py_TYPE macro instead of self->ob_type. Initial patch by Ammar Askar.
* | Issue #26462: Merge code block fixes from 3.5Martin Panter2016-07-294-14/+25
|\ \ | |/
| * Issue #26462: Doc: reduce literal_block warnings, fix syntax highlighting.Martin Panter2016-07-264-14/+25
| | | | | | | | Patch by Julien Palard.
* | Issue #17264: Fix cross refs and a markup error in extending/building.rstBerker Peksag2016-04-091-5/+6
|\ \ | |/
| * Issue #17264: Fix cross refs and a markup error in extending/building.rstBerker Peksag2016-04-091-5/+6
| |
* | merge with 3.5Georg Brandl2016-02-262-2/+2
|\ \ | |/
| * Closes #25910: fix dead and permanently redirected links in the docs. Thanks ↵Georg Brandl2016-02-262-2/+2
| | | | | | | | to SilentGhost for the patch.
* | Merge with 3.5Terry Jan Reedy2016-01-091-1/+1
|\ \ | |/
| * Issue #26029: Finish correction.Terry Jan Reedy2016-01-091-1/+1
| |
* | Merge with 3.5Terry Jan Reedy2016-01-091-1/+1
|\ \ | |/
| * Issue #26029: Remove extraneous word. Patch by Upendra Kumar.Terry Jan Reedy2016-01-091-1/+1
| |
* | Issue #5319: New Py_FinalizeEx() API to exit with status 120 on failureMartin Panter2015-11-301-2/+4
|/
* Issue #25022: Merge with 3.4Zachary Ware2015-09-101-143/+3
|\
| * Issue #25022: Add NEWS, fix docs to not mention the old example.Zachary Ware2015-09-101-144/+3
| |
* | Issue #24808: Merge 3.4 into 3.5; adjust new tp_as_async fieldMartin Panter2015-08-251-3/+3
|\ \ | |/
| * Issue #24808: Update the documentation of some PyTypeObject fieldsMartin Panter2015-08-251-3/+3
| | | | | | | | Patch by Joseph Weston.
* | Issue #24680: Merge with 3.4Zachary Ware2015-07-221-1/+1
|\ \ | |/
| * Issue #24680: Remove random backslash. Patch by cdz.Zachary Ware2015-07-221-1/+1
| |
generated by cgit v0.12 at 2025-04-24 10:30:29 (GMT)