[Doc] Document configure options in the Python documentation

[vstinner]

BPO	43774
Nosy	@rhettinger, @orsenthil, @vstinner, @pablogsal, @miss-islington
PRs	bpo-43774: Document configure options #25283 bpo-43774: Enhance configure documentation #25293 bpo-43774: Doc job of Azure Pipelines uses Doc/requirements.txt #25296 bpo-43774: Document the Python Build System #25302 bpo-43774: Add more links to configure options #25363 bpo-43774: Remove --without-cycle-gc doc #25364 bpo-43774: Remove unused PYMALLOC_DEBUG macro #25711 bpo-43774: Enhance debug build documentation #25712 bpo-43795 - Update Stable ABI dat. #25716

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2021-05-26.22:18:39.914>
created_at = <Date 2021-04-08.16:18:07.052>
labels = ['3.10', 'docs']
title = '[Doc] Document configure options in the Python documentation'
updated_at = <Date 2021-05-26.22:18:39.913>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2021-05-26.22:18:39.913>
actor = 'vstinner'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-05-26.22:18:39.914>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2021-04-08.16:18:07.052>
creator = 'vstinner'
dependencies = []
files = []
hgrepos = []
issue_num = 43774
keywords = ['patch']
message_count = 16.0
messages = ['390536', '390553', '390557', '390573', '390574', '390575', '390576', '390582', '390605', '390606', '390611', '390861', '390909', '392292', '392299', '394476']
nosy_count = 6.0
nosy_names = ['rhettinger', 'orsenthil', 'vstinner', 'docs@python', 'pablogsal', 'miss-islington']
pr_nums = ['25283', '25293', '25296', '25302', '25363', '25364', '25711', '25712', '25716']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue43774'
versions = ['Python 3.10']

[vstinner]

Attached PR documents configure, compiler and linker options to build Python.

[vstinner]

New changeset a41782c by Victor Stinner in branch 'master':
bpo-43774: Document configure options (GH-25283)
a41782c

[vstinner]

With Sphinx 2, there is an error on the Docs PR job of Azure Pipelines:

Warning, treated as error:
/home/vsts/work/1/s/Doc/using/configure.rst:416:unknown option: --enable-universalsdk

[vstinner]

The following syntax fails on the Docs PR job of the Azure Pipelines:
------------------
.. cmdoption:: --with-cxx-main
.. cmdoption:: --with-cxx-main=COMPILER

Compile the Python main() function and link Python executable with C++
compiler: $CXX, or COMPILER if specified.
------------------

Error:
------------------
Warning, treated as error:
/home/vsts/work/1/s/Doc/using/configure.rst:47:Duplicate explicit target name: "cmdoption--with-cxx-main".
Makefile:49: recipe for target 'build' failed
------------------

[vstinner]

The following syntax fails on the Docs PR job of the Azure Pipelines:

It uses Sphinx 2.2.0. Do we still support Spinx 2.2.0?

Collecting sphinx==2.2.0
...
Successfully installed Jinja2-2.11.3 MarkupSafe-1.1.1 Pygments-2.8.1 alabaster-0.7.12 babel-2.9.0 blurb-1.0.8 certifi-2020.12.5 chardet-4.0.0 docutils-0.17 idna-2.10 imagesize-1.2.0 packaging-20.9 pyparsing-2.4.7 python-docs-theme-2020.12 pytz-2021.1 requests-2.25.1 snowballstemmer-2.1.0 sphinx-2.2.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 urllib3-1.26.4

[vstinner]

New changeset 5436695 by Victor Stinner in branch 'master':
bpo-43774: Enhance configure documentation (GH-25293)
5436695

[vstinner]

I wrote PR 25296 to reuse Doc/requirements.txt in the Docs PR job of Azure Pipelines. It installs Sphinx 3.2.1 as expected, and with this version, no warning is emitted.

[rhettinger]

Thanks for adding this.

[miss-islington]

New changeset f7be26a by Victor Stinner in branch 'master':
bpo-43774: Doc job of Azure Pipelines uses Doc/requirements.txt (GH-25296)
f7be26a

[vstinner]

Raymond:

Thanks for adding this.

You're welcome :-) I plan to send an email to python-dev to ask for reviews. I hesitated to ask for a review on the PR, but honestly, it's painful to read plain text Sphinx. I prefer to read HTML ;-)

[vstinner]

New changeset bd88ccb by Victor Stinner in branch 'master':
bpo-43774: Document the Python Build System (GH-25302)
bd88ccb

[pablogsal]

New changeset 2459b92 by Victor Stinner in branch 'master':
bpo-43774: Remove --without-cycle-gc doc (GH-25364)
2459b92

[vstinner]

New changeset 85918e4 by Victor Stinner in branch 'master':
bpo-43774: Add more links to configure options (GH-25363)
85918e4

[vstinner]

New changeset 645ed62 by Victor Stinner in branch 'master':
bpo-43774: Remove unused PYMALLOC_DEBUG macro (GH-25711)
645ed62

[vstinner]

New changeset abfd638 by Victor Stinner in branch 'master':
bpo-43774: Enhance debug build documentation (GH-25712)
abfd638

[vstinner]

The documentation is now online: https://docs.python.org/dev/using/configure.html