aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Python-module.md
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2021-10-04 22:19:07 +0300
committerGitHub <noreply@github.com>2021-10-04 22:19:07 +0300
commit2d65472c725f18b343aee00bf91b9ac98c08b95f (patch)
tree530a0d6ffee4ee96e875302cbeba660c93056d41 /docs/markdown/Python-module.md
parent75dd9fb67f793c687fa45744f3b276e35c87ca09 (diff)
parentb672ebca886dd6dc9b0f775eb769764750fd302c (diff)
downloadmeson-2d65472c725f18b343aee00bf91b9ac98c08b95f.zip
meson-2d65472c725f18b343aee00bf91b9ac98c08b95f.tar.gz
meson-2d65472c725f18b343aee00bf91b9ac98c08b95f.tar.bz2
Merge pull request #8960 from mensinda/yamlDoc
Reference Manual 2.0
Diffstat (limited to 'docs/markdown/Python-module.md')
-rw-r--r--docs/markdown/Python-module.md31
1 files changed, 11 insertions, 20 deletions
diff --git a/docs/markdown/Python-module.md b/docs/markdown/Python-module.md
index 6f4120d..5d7b5ed 100644
--- a/docs/markdown/Python-module.md
+++ b/docs/markdown/Python-module.md
@@ -30,7 +30,7 @@ installation will be the one used to run Meson.
If provided, it can be:
- A simple name, eg `python-2.7`, Meson will look for an external program
- named that way, using [find_program]
+ named that way, using [[find_program]]
- A path, eg `/usr/local/bin/python3.4m`
@@ -49,7 +49,7 @@ Keyword arguments are the following:
[`feature`](Build-options.md#features) option can also be passed to the
`required` keyword argument.
- `disabler`: if `true` and no python installation can be found, return a
- [disabler object](Reference-manual.md#disabler-object) instead of a not-found object.
+ [[@disabler]] object instead of a not-found object.
*Since 0.49.0*
- `modules`: a list of module names that this python installation must have.
*Since 0.51.0*
@@ -58,7 +58,7 @@ Keyword arguments are the following:
## `python_installation` object
-The `python_installation` object is an [external program], with several
+The `python_installation` object is an [[@external_program]], with several
added methods.
### Methods
@@ -80,11 +80,11 @@ provided prior to 0.50.0 due to a bug.
shared_module py_installation.extension_module(module_name, list_of_sources, ...)
```
-Create a `shared_module` target that is named according to the naming
+Create a [[shared_module]] target that is named according to the naming
conventions of the target platform.
All positional and keyword arguments are the same as for
-[shared_module], excluding `name_suffix` and `name_prefix`, and with
+[[shared_module]], excluding `name_suffix` and `name_prefix`, and with
the addition of the following:
- `subdir`: By default, Meson will install the extension module in
@@ -95,9 +95,9 @@ the addition of the following:
`extension_module` does not add any dependencies to the library so
user may need to add `dependencies : py_installation.dependency()`,
-see [][`dependency()`].
+see [[dependency]].
-**Returns**: a [buildtarget object]
+**Returns**: a [[@build_tgt]] object
#### `dependency()`
@@ -106,7 +106,7 @@ python_dependency py_installation.dependency(...)
```
This method accepts no positional arguments, and the same keyword
-arguments as the standard [dependency] function. It also supports the
+arguments as the standard [[dependency]] function. It also supports the
following keyword argument:
- `embed`: *(since 0.53.0)* If true, Meson will try to find a python
@@ -126,7 +126,7 @@ void py_installation.install_sources(list_of_files, ...)
Install actual python sources (`.py`).
All positional and keyword arguments are the same as for
-[install_data], with the addition of the following:
+[[install_data]], with the addition of the following:
- `pure`: On some platforms, architecture independent files are
expected to be placed in a separate directory. However, if the
@@ -149,7 +149,7 @@ string py_installation.get_install_dir(...)
Retrieve the directory [][`install_sources()`] will install to.
It can be useful in cases where `install_sources` cannot be used
-directly, for example when using [configure_file].
+directly, for example when using [[configure_file]].
This function accepts no arguments, its keyword arguments are the same
as [][`install_sources()`].
@@ -236,18 +236,9 @@ with [][`get_variable()`], false otherwise.
## `python_dependency` object
-This [dependency object] subclass will try various methods to obtain
+This [[@dep]] object subclass will try various methods to obtain
the compiler and linker arguments, starting with pkg-config then
potentially using information obtained from python's `sysconfig`
module.
It exposes the same methods as its parent class.
-
-[find_program]: Reference-manual.md#find_program
-[shared_module]: Reference-manual.md#shared_module
-[external program]: Reference-manual.md#external-program-object
-[dependency]: Reference-manual.md#dependency
-[install_data]: Reference-manual.md#install_data
-[configure_file]: Reference-manual.md#configure_file
-[dependency object]: Reference-manual.md#dependency-object
-[buildtarget object]: Reference-manual.md#build-target-object