summaryrefslogtreecommitdiffstats
path: root/Doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901) (GH-21928)Victor Stinner2020-08-201-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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)
* Doc: Keep the venv/* exclude pattern. (GH-15229)Miss Islington (bot)2019-08-261-2/+4
| | | | | | In case it has been previously created. (cherry picked from commit 73e054970193fc421c533564a4189be522f9c331) Co-authored-by: Julien Palard <julien@palard.fr>
* bpo-36567: Use manpages_url to create links for man pages (GH-13339)Batuhan Taşkaya2019-05-181-0/+3
|
* bpo-36007: Bump minimum sphinx version to 1.8 (GH-11887)Anthony Sottile2019-02-151-2/+2
| | | https://bugs.python.org/issue36007
* bpo-35564: add master_doc='contents' to conf.py (GH-11290)Jean-François B2018-12-221-0/+2
|
* Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423)Adrian Liaw2018-11-041-2/+7
|
* bpo-34962: make doctest in Doc/ now passes, and is enforced in CI (GH-9806)Stéphane Wirtel2018-10-121-0/+7
|
* bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)animalize2018-10-081-1/+1
| | | | | Let .chm document display non-ASCII characters properly Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
* bpo-30607: Use external python-doc-theme (GH-2017)Jon Wayne Parrott2018-03-011-2/+6
|
* bpo-31589 : Build PDF using xelatex for better UTF8 support. (#3940)Julien Palard2017-12-021-3/+2
| | | Also addresses doc build failures documented in bpo-32200.
* Exclude non-default VENVDIR in Doc builds (#3974)Ned Deily2017-10-121-1/+2
|
* bpo-31423: Fix building the PDF documentation (GH-3693)François Magimel2017-09-221-4/+8
| | | Use prefixed macro names for the `authoraddress` function, add T2A to the font encoding in LaTeX sources to support Cyrillic characters in the PDF documentation, and replace the deprecated `font_size` config option with `pointsize`.
* bpo-27200: Fix doctests in programming.rst and datetime.rst (#401)Marco Buttu2017-03-181-0/+1
|
* Rename Doc/README.txt to Doc/README.rst and add formatting (#104)Roger2017-02-151-1/+1
| | | | | | | | | | | | | | | | * Reformat Doc/README.txt to Doc/README.rst * Update mention of Doc/README.rst * Update mention of README.txt to README.rst * Make line fold * rstlint ignore Doc/README.rst * conf.py ignore Doc/README.rst * Update issue tracker url in Docs/README.rst
* Fix some sphinx warnings (#9)Ryan Gonzalez2017-02-111-15/+15
| | | | * Fix some deprecation warnings in Doc/conf.py * Fix an rst error in Misc/NEWS
* Issue #19489: Move the search box from sidebar to header and footer.Zachary Ware2016-09-091-1/+4
|
* issue27202 - Fix the mistake in changesets 70af472451cb (3.5) and ↵Senthil Kumaran2016-06-051-3/+2
| | | | | | | | | 2bb806539ca6 (3.6) exclude_patterns in Sphinx conf.py will exclude the .rsts from the build. It was incorrect exclude 2.x rsts in that. This fix contributed again Jelle Zijlstra, excludes doctests in whatsnew/2.7.rst from being exercised by using doctests skip option.
* issue27202 - Exclude 2.x release notes from python3 make doctests.Senthil Kumaran2016-06-051-2/+3
| | | | Patch contributed by Jelle Zijlstra.
* Issue #19731: Update copyright year in docs.p.o footerBerker Peksag2016-04-241-1/+1
| | | | | | | See https://mail.python.org/pipermail/python-legal-sig/2013-November/000059.html for details. Patch by Antoine Pitrou.
* Issue20969 - Set the Epub Author and Epub Publisher in Python docs.Senthil Kumaran2016-01-081-0/+5
|
* docs/conf: Undo changes in b2a3baa1c2b0; issue #24400Yury Selivanov2015-07-021-1/+1
|
* Issue #24400: Mention that __instancecheck__ is used in abc.Awaitable and ↵Yury Selivanov2015-07-011-1/+1
| | | | Coroutine
* Ignore .rst files in the venv directory.Brett Cannon2015-03-301-0/+3
|
* linkcheck: ignore issue URLs and PEP URLs (the latter until the PEPs are on ↵Georg Brandl2014-10-291-0/+10
| | | | www.python.org again).
* Use https:// URLs when referring to python.org hosts.Georg Brandl2014-10-291-1/+1
|
* Adjust the author field of the .tex files to reflect that docs are now ↵Georg Brandl2014-10-291-1/+1
| | | | maintained by all of us
* Move HTML templates to their own subdir.Georg Brandl2014-10-291-1/+1
|
* Move Sphinx extensions to their own subdir.Georg Brandl2014-10-291-1/+1
|
* Remove a few config values that keep the default values, move values to the ↵Georg Brandl2014-10-291-14/+11
| | | | correct section
* Remove deprecated and now unnecessary config value from conf.py.Georg Brandl2014-10-291-10/+0
|
* Remove unused and now removed config value.Georg Brandl2014-10-021-7/+1
|
* Fix overlooked conf.py setting in flattening of Doc directory.Ned Deily2014-10-011-1/+1
|
* Move Doc/tools/sphinxext content to Doc/tools, there is no need for the ↵Georg Brandl2014-09-301-3/+3
| | | | nested subdirectory anymore.
* Closes #21431: make docs depend on Sphinx 1.2 and fix pydoc-topics builder toGeorg Brandl2014-09-221-1/+1
| | | | return Unicode strings on Python 3.
* Merge in all documentation changes since branching 3.4.0rc1.Larry Hastings2014-03-161-2/+4
|
* Introduce support for documenting which C API elements are not part of the ↵Georg Brandl2013-10-121-2/+2
| | | | stable/limited API.
* Determine opensearch URL from current version.Georg Brandl2012-04-071-1/+1
|
* Closes #14511: merge with 3.2Georg Brandl2012-04-071-1/+1
|\
| * Closes #14511: fix wrong opensearch link for 3.2 docs.Georg Brandl2012-04-071-1/+1
|/
* Switch to new "lighter" doc design.Georg Brandl2012-03-251-1/+4
|
* Remove "documenting" latex document.Georg Brandl2012-01-161-2/+0
|
* Build a PDF of the FAQs too.Georg Brandl2010-11-121-0/+2
|
* Issue #9308: Removed redundant coding cookies. Added tests forAlexander Belopolsky2010-10-151-1/+0
| | | | | importing encoded modules that do not depend on specific stdlib modules being encoded in a certain way.
* More inclusive title.Georg Brandl2010-09-031-1/+1
|
* More descriptive title.Raymond Hettinger2010-09-011-1/+1
|
* #3143: enable "collapsible sidebar" feature of new Sphinx version.Georg Brandl2010-07-301-0/+3
|
* Update Sphinx to 1.0.1.Georg Brandl2010-07-271-1/+1
|
* more stable urlBenjamin Peterson2009-10-011-1/+1
|
* fix opensearch versionBenjamin Peterson2009-10-011-1/+1
|
* Merged revisions ↵Benjamin Peterson2009-09-111-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 74277,74321,74323,74326,74355,74465,74467,74488,74492,74513,74531,74549,74553,74625,74632,74643-74644,74647,74652,74666,74671,74727,74739 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r74277 | sean.reifschneider | 2009-08-01 18:54:55 -0500 (Sat, 01 Aug 2009) | 3 lines - Issue #6624: yArg_ParseTuple with "s" format when parsing argument with NUL: Bogus TypeError detail string. ........ r74321 | guilherme.polo | 2009-08-05 11:51:41 -0500 (Wed, 05 Aug 2009) | 1 line Easier reference to find (at least while svn continues being used). ........ r74323 | guilherme.polo | 2009-08-05 18:48:26 -0500 (Wed, 05 Aug 2009) | 1 line Typo. ........ r74326 | jesse.noller | 2009-08-05 21:05:56 -0500 (Wed, 05 Aug 2009) | 1 line Fix issue 4660: spurious task_done errors in multiprocessing, remove doc note for from_address ........ r74355 | gregory.p.smith | 2009-08-12 12:02:37 -0500 (Wed, 12 Aug 2009) | 2 lines comment typo fix ........ r74465 | vinay.sajip | 2009-08-15 18:23:12 -0500 (Sat, 15 Aug 2009) | 1 line Added section on logging to one file from multiple processes. ........ r74467 | vinay.sajip | 2009-08-15 18:34:47 -0500 (Sat, 15 Aug 2009) | 1 line Refined section on logging to one file from multiple processes. ........ r74488 | vinay.sajip | 2009-08-17 08:14:37 -0500 (Mon, 17 Aug 2009) | 1 line Further refined section on logging to one file from multiple processes. ........ r74492 | r.david.murray | 2009-08-17 14:26:49 -0500 (Mon, 17 Aug 2009) | 2 lines Issue 6685: 'toupper' -> 'upper' in cgi doc example explanation. ........ r74513 | skip.montanaro | 2009-08-18 09:37:52 -0500 (Tue, 18 Aug 2009) | 1 line missing module ref (issue6723) ........ r74531 | vinay.sajip | 2009-08-20 17:04:32 -0500 (Thu, 20 Aug 2009) | 1 line Added section on exceptions raised during logging. ........ r74549 | benjamin.peterson | 2009-08-24 12:42:36 -0500 (Mon, 24 Aug 2009) | 1 line fix pdf building by teaching latex the right encoding package ........ r74553 | r.david.murray | 2009-08-26 20:04:59 -0500 (Wed, 26 Aug 2009) | 2 lines Remove leftover text from end of sentence. ........ r74625 | benjamin.peterson | 2009-09-01 17:27:57 -0500 (Tue, 01 Sep 2009) | 1 line remove the check that classmethod's argument is a callable ........ r74632 | georg.brandl | 2009-09-03 02:27:26 -0500 (Thu, 03 Sep 2009) | 1 line #6828: fix wrongly highlighted blocks. ........ r74643 | georg.brandl | 2009-09-04 01:59:20 -0500 (Fri, 04 Sep 2009) | 2 lines Issue #2666: Handle BROWSER environment variable properly for unknown browser names in the webbrowser module. ........ r74644 | georg.brandl | 2009-09-04 02:55:14 -0500 (Fri, 04 Sep 2009) | 1 line #5047: remove Monterey support from configure. ........ r74647 | georg.brandl | 2009-09-04 03:17:04 -0500 (Fri, 04 Sep 2009) | 2 lines Issue #5275: In Cookie's Cookie.load(), properly handle non-string arguments as documented. ........ r74652 | georg.brandl | 2009-09-04 06:25:37 -0500 (Fri, 04 Sep 2009) | 1 line #6756: add some info about the "acct" parameter. ........ r74666 | georg.brandl | 2009-09-05 04:04:09 -0500 (Sat, 05 Sep 2009) | 1 line #6841: remove duplicated word. ........ r74671 | georg.brandl | 2009-09-05 11:47:17 -0500 (Sat, 05 Sep 2009) | 1 line #6843: add link from filterwarnings to where the meaning of the arguments is covered. ........ r74727 | benjamin.peterson | 2009-09-08 18:04:22 -0500 (Tue, 08 Sep 2009) | 1 line #6865 fix ref counting in initialization of pwd module ........ r74739 | georg.brandl | 2009-09-11 02:55:20 -0500 (Fri, 11 Sep 2009) | 1 line Move function back to its section. ........
generated by cgit v0.12 at 2025-01-19 19:07:14 (GMT)