Skip to content

Commit 2560faa

Browse files
author
Release Manager
committed
gh-41312: Explain how to disable generating targets for docbuilding at pip install step
Follow-up on #41191. In the "background information" section below there's a guide how to do the equivalent with `meson`, but having more can't hurt (hopefully). ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #41312 Reported by: user202729 Reviewer(s):
2 parents 376adca + b85ab63 commit 2560faa

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

build/pkgs/configure/checksums.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
tarball=configure-VERSION.tar.gz
2-
sha1=76e36392eb4d20d4227973f86f5844387a91a06b
3-
sha256=fdb7c78df304acf8f90c51e1f217955ecd240f200776beb98b7a9f8024a3bdb4
2+
sha1=913dff3a94c24015249a01a380887618020081df
3+
sha256=4d02a57142c84651054601dfd7a688737829fd12046dbe166f21ac4136a83d93
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7262ca702f91ecc1d2fac081968e79795c013e02
1+
e8e64a6d7bf508c67a6abf5a3213f43904817584

src/doc/en/installation/source.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,15 @@ Remarks
208208
run in parallel based on the number of CPU available. This can be adjusted
209209
by passing ``--config-settings=compile-args=-jN`` to ``pip install``.
210210

211+
If you don't need to build the documentation, pass
212+
``--config-settings=setup-args=-Dbuild-docs=false`` to ``pip install``
213+
to speed up the target generation step.
214+
215+
The parameter ``setup-args`` etc. are documented in
216+
`<https://mesonbuild.com/meson-python/how-to-guides/config-settings.html>`_.
217+
``setup-args`` are passed to ``meson``, effect ``compile-args``
218+
are passed to ``ninja``.
219+
211220
``--verbose`` can be passed to ``pip install``, then the meson commands
212221
internally used by pip will be printed out.
213222

0 commit comments

Comments
 (0)