Skip to content

Commit 792e274

Browse files
story645ksundenQuLogic
committed
Added info for getting compilation output from meson on autorebuild
and added meson-python to intersphinx Co-authored-by: Kyle Sunden <git@ksunden.space> Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
1 parent e394940 commit 792e274

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ def _check_dependencies():
207207
'scipy': ('https://docs.scipy.org/doc/scipy/', None),
208208
'tornado': ('https://www.tornadoweb.org/en/stable/', None),
209209
'xarray': ('https://docs.xarray.dev/en/stable/', None),
210+
'meson-python': ('https://meson-python.readthedocs.io/en/stable/', None)
210211
}
211212

212213

doc/devel/development_setup.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,12 +164,23 @@ command ::
164164

165165
The 'editable/develop mode' builds everything and places links in your Python environment
166166
so that Python will be able to import Matplotlib from your development source directory.
167-
This allows you to import your modified version of Matplotlib without re-installing after
168-
every change. Note that before the merging of the `Meson port
169-
<https://github.com/matplotlib/matplotlib/pull/26621>`_, this is only true for ``*.py``
170-
files. If you change the C-extension source based on a commit before the change to the
171-
Meson build system (which might also happen if you change branches), you will have to
172-
re-run the above command.
167+
This allows you to import your modified version of Matplotlib without having to
168+
re-install after changing a ``.py`` or compiled extension file. On Windows, you
169+
may need to :external+meson-python:ref:`vsenv-example`.
170+
171+
If you are working heavily with files that need to be compiled, you may want to
172+
inspect the compilation log. This can be enabled temporarily by setting the environment
173+
variable :envvar:`MESONPY_EDITABLE_VERBOSE` or permanently by setting the
174+
``editable-verbose`` config when installing ::
175+
176+
python -m pip install --no-build-isolation --config-settings=editable-verbose=true --editable .
177+
178+
For more information on installation and other configuration options, see the
179+
Meson Python :external+meson-python:ref:`editable installs guide <how-to-guides-editable-installs>`.
180+
Meson was enabled in :ghpull:`26621`; therefore you will have to reinstall
181+
each time you change any compiled extension code when working on a branch that
182+
does not have the commits from that pull request in its history (log).
183+
173184

174185
Verify the Installation
175186
=======================

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,4 +287,7 @@ ignore_messages = [
287287
"Hyperlink target \".*\" is not referenced.",
288288
"Duplicate implicit target name: \".*\".",
289289
"Duplicate explicit target name: \".*\".",
290+
# sphinx.ext.intersphinx directives
291+
"No role entry for \"external+.*\".",
292+
"Unknown interpreted text role \"external+.*\"."
290293
]

0 commit comments

Comments
 (0)