[issue43774] [Doc] Document configure options in the Python documentation
New submission from STINNER Victor <vstinner@python.org>: Attached PR documents configure, compiler and linker options to build Python. ---------- assignee: docs@python components: Documentation messages: 390536 nosy: docs@python, vstinner priority: normal severity: normal status: open title: [Doc] Document configure options in the Python documentation versions: Python 3.10 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- keywords: +patch pull_requests: +24019 stage: -> patch review pull_request: https://github.com/python/cpython/pull/25283 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset a41782cc84bcd813209a03e6e11c60e77dbc7718 by Victor Stinner in branch 'master': bpo-43774: Document configure options (GH-25283) https://github.com/python/cpython/commit/a41782cc84bcd813209a03e6e11c60e77db... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: 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 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24026 pull_request: https://github.com/python/cpython/pull/25293 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: 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 ------------------ ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment:
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 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset 54366953633dbe5d9585dbae0c633d4e92df2d04 by Victor Stinner in branch 'master': bpo-43774: Enhance configure documentation (GH-25293) https://github.com/python/cpython/commit/54366953633dbe5d9585dbae0c633d4e92d... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24027 pull_request: https://github.com/python/cpython/pull/25296 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: Thanks for adding this. ---------- nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset f7be26a8f2ed588df90959ae7c0fdcafe2091f76 by Victor Stinner in branch 'master': bpo-43774: Doc job of Azure Pipelines uses Doc/requirements.txt (GH-25296) https://github.com/python/cpython/commit/f7be26a8f2ed588df90959ae7c0fdcafe20... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: 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 ;-) ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24033 pull_request: https://github.com/python/cpython/pull/25302 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset bd88ccb943c0ea672c14a87e76157fade4feae11 by Victor Stinner in branch 'master': bpo-43774: Document the Python Build System (GH-25302) https://github.com/python/cpython/commit/bd88ccb943c0ea672c14a87e76157fade4f... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24097 pull_request: https://github.com/python/cpython/pull/25363 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24098 pull_request: https://github.com/python/cpython/pull/25364 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Pablo Galindo Salgado <pablogsal@gmail.com> added the comment: New changeset 2459b92a4db69d9b14d0a86a9b81cc075894e910 by Victor Stinner in branch 'master': bpo-43774: Remove --without-cycle-gc doc (GH-25364) https://github.com/python/cpython/commit/2459b92a4db69d9b14d0a86a9b81cc07589... ---------- nosy: +pablogsal _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset 85918e4ab6e9410008aef6dedf000d24b3e120ea by Victor Stinner in branch 'master': bpo-43774: Add more links to configure options (GH-25363) https://github.com/python/cpython/commit/85918e4ab6e9410008aef6dedf000d24b3e... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24400 pull_request: https://github.com/python/cpython/pull/25711 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by STINNER Victor <vstinner@python.org>: ---------- pull_requests: +24401 pull_request: https://github.com/python/cpython/pull/25712 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset 645ed62fb4c09b7e23887fcca0767b0f2d7d3fd6 by Victor Stinner in branch 'master': bpo-43774: Remove unused PYMALLOC_DEBUG macro (GH-25711) https://github.com/python/cpython/commit/645ed62fb4c09b7e23887fcca0767b0f2d7... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
STINNER Victor <vstinner@python.org> added the comment: New changeset abfd6388cdba376a72686df52a9a98b2d558271b by Victor Stinner in branch 'master': bpo-43774: Enhance debug build documentation (GH-25712) https://github.com/python/cpython/commit/abfd6388cdba376a72686df52a9a98b2d55... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
Change by Senthil Kumaran <senthil@uthcode.com>: ---------- nosy: +orsenthil nosy_count: 5.0 -> 6.0 pull_requests: +24406 pull_request: https://github.com/python/cpython/pull/25716 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue43774> _______________________________________
participants (5)
-
miss-islington -
Pablo Galindo Salgado
-
Raymond Hettinger
-
Senthil Kumaran
-
STINNER Victor