summaryrefslogtreecommitdiffstats
path: root/Doc/howto
Commit message (Collapse)AuthorAgeFilesLines
* Fixes dead links to Django's logging config docs (GH-20823) (GH-22171)Miss Islington (bot)2020-09-091-2/+2
| | | (cherry picked from commit 714217f9561507bbc7218a02089d0e1da0239372)
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-13/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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)
* Remove incorrect mention of method.__class__ in descriptor docs (GH-21665) ↵Miss Islington (bot)2020-07-291-4/+2
| | | | (GH-21668)
* Doc: change 'Posix' for 'POSIX' (GH-20001)Miss Islington (bot)2020-05-171-1/+1
| | | | | (cherry picked from commit 65460565df99fbda6a74b6bb4bf99affaaf8bd95) Co-authored-by: Mathieu Dupuy <mathieu.dupuy@doctolib.com>
* Doc: Fix external links to functional programming tutorial. (GH-18249)Miss Islington (bot)2020-01-291-3/+3
| | | | | (cherry picked from commit 35eac4500a8bd89b087407f59ba337343b22d403) Co-authored-by: Julien Palard <julien@palard.fr>
* Replace links in howto/pyporting.rst with sphinx references (GH-17781)Miss Islington (bot)2020-01-051-7/+3
| | | | | | Signed-off-by: Oleg Höfling <oleg.hoefling@gmail.com> (cherry picked from commit e6ae90dede07e8599cc6906417ca4aa99d8aa6e4) Co-authored-by: Oleg Höfling <hoefling@users.noreply.github.com>
* [3.8] bpo-38830: Correct slot signature in Qt example. (GH-17220) (GH-17221)Vinay Sajip2019-11-181-1/+1
| | | (cherry picked from commit 5383956583bb758f3828513bcdd011871f24a0e8)
* [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] Correct Roman-numeral example in Unicode HOWTO. (GH-15541). (GH-15728)Serhiy Storchaka2019-09-081-6/+6
| | | | | (cherry picked from commit 32a960f8e1015b64b4b955b3d62920c5903d4c6f) Co-authored-by: Greg Price <gnprice@gmail.com>
* bpo-25777: Wording describes a lookup, not a call (GH-15573) (GH-15576)Miss Islington (bot)2019-08-291-1/+1
| | | | | (cherry picked from commit 03acba6f1a851064ba1fa78965ece4354d499c04) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
* Refined Qt GUI example in the logging cookbook. (GH-15045) (GH-15046)Miss Islington (bot)2019-07-311-17/+39
| | | (cherry picked from commit 472eced6770c2fabab3031e4e16cd32e32b8a0cc)
* Add Qt GUI example to the logging cookbook. (GH-14978) (GH-14979)Miss Islington (bot)2019-07-271-0/+213
| | | (cherry picked from commit 1ed915e8ae3cc59ad8f7a8eaccb94f27f19b10a6)
* Update logging cookbook to show multiple worker processes using the ↵Miss Islington (bot)2019-07-221-0/+35
| | | | | concurrent.futures module. (GH-14905) (GH-14906) (cherry picked from commit d309352c6fd93a51f2b3011ca8c2125d3a5d394b)
* bpo-32934: Clarified meaning of 'capacity' for BufferingHandler and ↵Miss Islington (bot)2019-07-011-3/+3
| | | | | MemoryHandler. (GH-14498) (GH-14507) (cherry picked from commit 84de34e39eb9e49b2ae691c6f67df8d7da3561de)
* Use more PEP 570 syntax in the documentation. (GH-13720)Serhiy Storchaka2019-06-011-15/+15
|
* bpo-36842: Implement PEP 578 (GH-12613)Steve Dower2019-05-231-0/+9
| | | Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs.
* docs 36789: resolve incorrect note regarding UTF-8 (GH-13111)redshiftzero2019-05-171-5/+10
|
* Doc: Replace the deprecated highlightlang directive by highlight. (#13377)Stéphane Wirtel2019-05-172-2/+2
| | | | highlightlang is deprecated since April 2018 in Sphinx. See https://github.com/sphinx-doc/sphinx/pull/4845
* doc: fix broken link on howto/unicode page (#13160)redshiftzero2019-05-091-1/+1
| | | Thank you @redshiftzero on the first PR :clap:
* bpo-32913: Added re.Match.groupdict example to regex HOWTO (GH-5821)josh2019-04-171-0/+7
|
* bpo-23984: Improve descriptor documentation (GH-1034)Shubham Aggarwal2019-03-201-2/+2
| | | https://bugs.python.org/issue23984
* bpo-20906: Various revisions to the Unicode howto (#8394)Andrew Kuchling2019-03-041-158/+183
| | | | | | * bpo-20906: Corrections & revisions to Unicode HOWTO * bpo-34484: don't describe range as a Private Use Area
* bpo-35584: Clarify role of caret in a class class (GH-11946)Raymond Hettinger2019-02-191-2/+3
| | | https://bugs.python.org/issue35584
* bpo-35781: Changed references to deprecated 'warn' method in logging ↵yuji38kwmt2019-01-232-4/+4
| | | | documentation in favour of 'warning' (GH-11654)
* bpo-35722: Updated the documentation for the 'disable_existing_loggers' ↵Géry Ogam2019-01-231-5/+5
| | | | parameter (GH-11525)
* bpo-35506: Remove redundant and incorrect links from keywords. (GH-11174)Serhiy Storchaka2018-12-191-1/+1
|
* bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)Serhiy Storchaka2018-10-311-1/+1
|
* bpo-35042: Use the :pep: role where a PEP is specified (#10036)Stéphane Wirtel2018-10-261-1/+1
|
* Remove ">>>" from testsetup. (GH-10017)Benjamin Peterson2018-10-201-1/+1
| | | Fixes doc build breakage from 890a4b92933be8e7c554222d99ef829c88fa8637.
* bpo-35020: Link to sorting examples from list.sort() (GH-9931)Xtreak2018-10-201-1/+12
|
* Added CLI starter example to logging cookbook. (GH-9910)Vinay Sajip2018-10-161-0/+161
|
* Remove recent from logging cookbook (GH-9636)Cheryl Sabella2018-10-021-3/+2
|
* Improved the more elaborate multiprocessing example in the logging cookbook ↵Géry Ogam2018-09-251-29/+29
| | | | (GH-9326)
* bpo-24937: Replace the extension module porting HOWTO by links to external ↵Petr Viktorin2018-09-241-249/+18
| | | | projects (GH-9317)
* Fix "Python" casing in a few places (GH-9001)Andrés Delfino2018-09-142-4/+4
|
* switch descriptor howto to return value annotation (GH-7796)NotAFile2018-09-101-3/+3
|
* Revert "Fix misindented yaml in logging how to example (GH-8604)" (GH-9081)Rémy HUBSCHER2018-09-101-3/+3
| | | This reverts commit 10b59f1b019cd00c940dd7f4a74c4f667a20f25f.
* Fix misindented yaml in logging how to example (GH-8604)Rémy HUBSCHER2018-08-121-3/+3
|
* Make code examples in Functional Programming HOWTO to be PEP 8 compliant. ↵Sergey Fedoseev2018-08-071-23/+23
| | | | (GH-8646)
* bpo-20260: Implement non-bitwise unsigned int converters for Argument ↵Serhiy Storchaka2018-07-261-0/+6
| | | | Clinic. (GH-8434)
* bpo-34083: Update dict order in Functional HOWTO (GH-8230)Stig Johan Berggren2018-07-111-11/+12
|
* bpo-30660: Doc: Optimize PNG files by optipng (GH-8032)INADA Naoki2018-07-011-0/+0
| | | | Using OptiPNG 0.7.7. Used command is: `find . -name '*.png' | xargs optipng -o7`
* bpo-33641: Convert RFC references into links. (GH-7103)Serhiy Storchaka2018-05-313-8/+8
| | | | 85% of them are already links.
* bpo-26103: Fix inspect.isdatadescriptor() and a data descriptor definition. ↵Aaron Hall, MBA2018-05-201-1/+1
| | | | | | (GH-1959) Look for '__set__' or '__delete__'.
* Docs: be less specific about python versions (GH-6985)Eitan Adler2018-05-201-2/+2
| | | | CPython 3.5 is old now, and we don't bump this version often, so lets avoid using specific versions.
* bpo-33503: Fix the broken pypi link in the source and the documentation ↵Stéphane Wirtel2018-05-152-10/+10
| | | | (GH-6814)
* bpo-33400: Clarified documentation to indicate no strict adherence to ISO ↵Vinay Sajip2018-05-041-3/+3
| | | | 8601. (GH-6702)
* Remove to-be-deprecated urllib.request.urlretrieve function reference (#6454)Andrés Delfino2018-04-161-4/+12
|
* Improve highlighting of some code blocks. (GH-6401)Serhiy Storchaka2018-04-088-64/+154
|
* bpo-32614: Modify re examples to use a raw string to prevent warning (GH-5265)Cheryl Sabella2018-02-022-5/+20
| | | | Modify RE examples in documentation to use raw strings to prevent DeprecationWarning. Add text to REGEX HOWTO to highlight the deprecation. Approved by Serhiy Storchaka.
generated by cgit v0.12 at 2025-01-29 17:09:10 (GMT)