summaryrefslogtreecommitdiffstats
path: root/Doc/tools
Commit message (Collapse)AuthorAgeFilesLines
...
* gh-101100: Fix sphinx warnings in `turtle.rst` (#109394)Nikita Sobolev2023-09-141-1/+0
|
* GH-104395: Add a link in 'Meta Information' to the docs download page (#104443)Adam Turner2023-09-121-0/+1
| | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` (#108810)Nikita Sobolev2023-09-021-1/+0
|
* gh-101100: Fix sphinx warnings in `uuid.rst` (#108805)Nikita Sobolev2023-09-021-1/+0
| | | | | * gh-101100: Fix sphinx warnings in `uuid.rst` * Use anchors
* gh-101100: Fix sphinx warnings in `tutorial/appendix.rst` (#108750)Nikita Sobolev2023-09-011-1/+0
| | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (#108746)Nikita Sobolev2023-09-011-1/+0
|
* gh-101100: Fix sphinx warnings in `threading.rst` (#108684)Nikita Sobolev2023-08-311-1/+0
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-101100: Fix Sphinx warnings in the Logging Cookbook (#108678)Hugo van Kemenade2023-08-301-1/+0
|
* Docs: Resolve Sphinx warnings in dis.rst (#108476)Erlend E. Aasland2023-08-251-1/+0
| | | | | - Link to the code objects reference - Suppress link to deliberately undocumented builtins.__build_class__ - Suppress links for example methods
* gh-107136: Remove Plausible for docs metrics (#107856)Hugo van Kemenade2023-08-221-3/+0
|
* gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)Serhiy Storchaka2023-08-221-1/+0
|
* gh-107298: Fix C API datetime documentation (GH-108034)Serhiy Storchaka2023-08-211-1/+0
|
* Improve references in the tutorial (GH-108069)Serhiy Storchaka2023-08-211-2/+0
| | | | | * Use full qualified names for references (even if they do not work now, they will work in future). * Silence references to examples.
* Resolve reference warnings in faq/gui.rst (#108147)Adam Turner2023-08-211-1/+0
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Resolve reference warnings in faq/library.rst (#108149)Adam Turner2023-08-201-1/+0
| | | | | Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Resolve reference warnings in faq/design.rst (#108148)Adam Turner2023-08-201-1/+0
|
* Resolve reference warnings in faq/programming.rst (#108150)Adam Turner2023-08-201-1/+0
|
* Docs: Fix Sphinx warnings in logging.rst (GH-108139)Erlend E. Aasland2023-08-201-1/+0
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Docs: Fix Sphinx warnings in license.rst (#108142)Erlend E. Aasland2023-08-201-1/+0
| | | | - Fix links to stdlib modules - Silence links to external functions
* Docs: Fix Sphinx warnings in sys.rst (#108106)Erlend E. Aasland2023-08-201-1/+0
| | | | | | | | | | | | | | | | - Mark up named tuple attributes as attributes - Remove links for external functions - io.BufferedIOBase has no 'buffer' attribute; remove the link and mark up using :attr:`!buffer` - (Re)format some tables as bullet lists: - sys._emscripten_info - sys.hash_info - sys.int_info - sys.thread_info - In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes', add links to the frame objects reference. Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-101100: Only show GitHub check annotations on changed doc paragraphs ↵C.A.M. Gerlach2023-08-191-22/+184
| | | | | | | | | | | | | (#108065) * Only show GitHub check annotations on changed doc paragraphs * Improve check-warnings script arg parsing following Hugo's suggestions * Factor filtering warnings by modified diffs into helper function * Build docs on unmerged branch so warning lines match & avoid deep clone --------- Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Docs: Fix Sphinx warnings in io.rst (#107903)Erlend E. Aasland2023-08-171-1/+0
| | | | | | - Mark up parameter and argument names properly - If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* gh-107298: Fix C API Buffer documentation (#108011)Victor Stinner2023-08-161-1/+0
|
* Docs: Fix more Sphinx annotations in ctypes.rst (#107708)Erlend E. Aasland2023-08-071-1/+0
|
* Do not use deprecated ``logger.warn()`` in pyspecific (#107694)Adam Turner2023-08-061-3/+3
|
* GH-84435: Make pyspecific directives translatable (#19470)cocoatomo2023-08-061-10/+8
| | | | | Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Docs: Only include Plausible for html, not for epub etc (#107637)Hugo van Kemenade2023-08-041-1/+3
| | | Only include Plausible for html, not for epub etc
* gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386)Serhiy Storchaka2023-07-291-36/+0
|
* gh-107091: Fix some uses of :const: role (GH-107379)Serhiy Storchaka2023-07-281-1/+0
| | | It is for references, not for literals.
* gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)Serhiy Storchaka2023-07-271-4/+0
|
* gh-107298: Docs: add targets for some :c:member: and :c:macro: references ↵Serhiy Storchaka2023-07-271-1/+0
| | | | | | | | (GH-107316) Add targets for PyStructSequence_Desc and PyStructSequence_Field members and macros like Py_EQ. Fix target for Py_RETURN_RICHCOMPARE.
* gh-107091: Fix some uses of :attr: role (GH-107318)Serhiy Storchaka2023-07-271-1/+0
| | | | Fix also formatting of PyMethodDef members.
* gh-107298: Fix more Sphinx warnings in the C API doc (#107329)Victor Stinner2023-07-271-3/+0
| | | | | | | | | | | | | | | | | | | | | | | Declare the following functions as macros, since they are actually macros. It avoids a warning on "TYPE" or "macro" argument. * PyMem_New() * PyMem_Resize() * PyModule_AddIntMacro() * PyModule_AddStringMacro() * PyObject_GC_New() * PyObject_GC_NewVar() * PyObject_New() * PyObject_NewVar() Add C standard C types to nitpick_ignore in Doc/conf.py: * int64_t * uint64_t * uintptr_t No longer ignore non existing "__int" type in nitpick_ignore. Update Doc/tools/.nitignore
* gh-107298: Fix Sphinx warnings in the C API doc (#107302)Victor Stinner2023-07-261-7/+0
| | | | * Update Doc/tools/.nitignore * Fix BufferedIOBase.write() link in buffer.rst
* gh-107298: Fix doc references to undocumented modules (#107300)Victor Stinner2023-07-261-2/+0
| | | Update also Doc/tools/.nitignore.
* gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295)Victor Stinner2023-07-261-3/+0
| | | | | | | | | | | Update the nitpick_ignore of the documentation configuration to fix Sphinx warnings about standard C types when declaring functions with the "c:function" markups. Copy standard C types declared in the "c:type" domain to the "c:identifier" domain, since "c:function" markup looks for types in the "c:identifier" domain. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-106948: Docs: Disable links for C standard library functions, OS utility ↵Erlend E. Aasland2023-07-231-1/+0
| | | | | functions and system calls (#107062) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* Remove superflous whitespaces in `layout.html`. (GH-107067)Ezio Melotti2023-07-231-4/+4
|
* gh-101100: Fix some broken sphinx references (#107095)wulmer2023-07-231-10/+0
|
* gh-106948: Add standard external names to nitpick_ignore (GH-106949)Serhiy Storchaka2023-07-221-7/+0
| | | | | It includes standard C types, macros and variables like "size_t", "LONG_MAX" and "errno", and standard environment variables like "PATH".
* Fix Sphinx warnings in `re` module docs (#107044)wulmer2023-07-221-1/+0
|
* gh-101100: Docs: Check Sphinx warnings and fail if improved (#106460)Hugo van Kemenade2023-07-224-99/+151
|
* Docs search: Replace jQuery with vanilla JavaScript (#106743)Hugo van Kemenade2023-07-161-30/+44
| | | | * Replace jQuery with vanilla JavaScript * Switch 'var' to 'const' or 'let'
* Add Plausible for docs metrics (#106644)Hugo van Kemenade2023-07-121-0/+1
|
* Clarify how topics.py gets created. (#106121)Ned Batchelder2023-07-101-0/+1
| | | | | | | | | When changing docs, it was easy to find text in topics.py, and I wondered whether I was supposed to edit it. Thankfully, the top of the file says it's auto-generated, so I knew I didn't have to edit it. But I didn't know what started the auto-generation process. It's part of the release process, so I'll leave a note here for future editors.
* Docs: Avoid a DeprecationWarning in `pyspecific.py` when running with Sphinx ↵Alex Waygood2023-06-231-11/+9
| | | | | >=6.1 (#105886) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* Use CSV-separated outputs @ get-changed-files @ CI (#105151)Sviatoslav Sydorenko2023-06-211-6/+27
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* gh-105096: Reformat wave documentation (#105136)Victor Stinner2023-05-311-1/+0
| | | | | | | | Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level. * Remove wave.rst from .nitignore
* gh-75552: Remove deprecated tkinter.tix module (GH-104902)Zachary Ware2023-05-271-1/+0
|
* gh-104804: Remove webbrowser.MacOSX class, deprecated in Python 3.11 (#104816)Hugo van Kemenade2023-05-261-1/+0
| | | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Victor Stinner <vstinner@python.org>