Staging
v0.8.1
Revision 7d0fef56d8eaac6309a66cb8c6ba6fd96f8c8a94 authored by Victor Stinner on 20 August 2020, 11:28:49 UTC, committed by GitHub on 20 August 2020, 11:28:49 UTC
* 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)
1 parent 34889a5
History
File Mode Size
clinic
stringlib
README -rw-r--r-- 41 bytes
abstract.c -rw-r--r-- 68.9 KB
accu.c -rw-r--r-- 2.4 KB
boolobject.c -rw-r--r-- 6.6 KB
bytearrayobject.c -rw-r--r-- 70.3 KB
bytes_methods.c -rw-r--r-- 21.2 KB
bytesobject.c -rw-r--r-- 99.5 KB
call.c -rw-r--r-- 36.2 KB
capsule.c -rw-r--r-- 7.3 KB
cellobject.c -rw-r--r-- 5.7 KB
classobject.c -rw-r--r-- 19.2 KB
codeobject.c -rw-r--r-- 34.3 KB
complexobject.c -rw-r--r-- 32.1 KB
descrobject.c -rw-r--r-- 58.3 KB
dict-common.h -rw-r--r-- 2.2 KB
dictnotes.txt -rw-r--r-- 6.0 KB
dictobject.c -rw-r--r-- 138.1 KB
enumobject.c -rw-r--r-- 13.4 KB
exceptions.c -rw-r--r-- 87.2 KB
fileobject.c -rw-r--r-- 16.9 KB
floatobject.c -rw-r--r-- 70.3 KB
frameobject.c -rw-r--r-- 33.1 KB
funcobject.c -rw-r--r-- 31.1 KB
genobject.c -rw-r--r-- 66.6 KB
interpreteridobject.c -rw-r--r-- 8.5 KB
iterobject.c -rw-r--r-- 9.2 KB
listobject.c -rw-r--r-- 98.2 KB
listsort.txt -rw-r--r-- 35.3 KB
lnotab_notes.txt -rw-r--r-- 5.9 KB
longobject.c -rw-r--r-- 175.3 KB
memoryobject.c -rw-r--r-- 91.7 KB
methodobject.c -rw-r--r-- 13.9 KB
moduleobject.c -rw-r--r-- 24.8 KB
namespaceobject.c -rw-r--r-- 7.4 KB
object.c -rw-r--r-- 61.8 KB
obmalloc.c -rw-r--r-- 86.8 KB
odictobject.c -rw-r--r-- 73.1 KB
picklebufobject.c -rw-r--r-- 6.0 KB
rangeobject.c -rw-r--r-- 34.6 KB
setobject.c -rw-r--r-- 73.2 KB
sliceobject.c -rw-r--r-- 19.1 KB
structseq.c -rw-r--r-- 14.7 KB
tupleobject.c -rw-r--r-- 31.3 KB
typeobject.c -rw-r--r-- 244.6 KB
typeslots.inc -rw-r--r-- 3.9 KB
typeslots.py -rwxr-xr-x 1.2 KB
unicodectype.c -rw-r--r-- 7.5 KB
unicodeobject.c -rw-r--r-- 460.5 KB
unicodetype_db.h -rw-r--r-- 246.9 KB
weakrefobject.c -rw-r--r-- 30.8 KB

README

back to top