diff options
| author | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2018-04-13 13:55:45 +0200 |
|---|---|---|
| committer | Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2018-04-26 14:34:03 +0000 |
| commit | 0d12d71920067be499d9237b4ad04f7f11047759 (patch) | |
| tree | 258ddf9f4b76a46f2abc656b6c725857b606c509 /sources/shiboken2/doc/typesystemvariables.rst | |
| parent | 0b842db3a95a44fbda3379d2093cb52f8ae2a1ff (diff) | |
Add references from ApiExtractor to shiboken doc
Including intersphinx extension allow us to link
the documentation from ApiExtractor to shiboken's.
ApiExtractor doc need to be build first, so we can
use the inventory that sphinx create, to link it
to shiboken's configuration.
All the harcoded references were replaced by dynamic
references. Also new labels were included to properly
cross reference topics.
Checked the spell on many rst files too.
Task-number: PYSIDE-363
Change-Id: I11a50b1f9eee48a00a3de6f957942eb0823eba47
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'sources/shiboken2/doc/typesystemvariables.rst')
| -rw-r--r-- | sources/shiboken2/doc/typesystemvariables.rst | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/sources/shiboken2/doc/typesystemvariables.rst b/sources/shiboken2/doc/typesystemvariables.rst index 9de2b02f5..e595f7ddc 100644 --- a/sources/shiboken2/doc/typesystemvariables.rst +++ b/sources/shiboken2/doc/typesystemvariables.rst @@ -3,7 +3,7 @@ Type System Variables ********************* User written code can be placed in arbitrary places using the -:doc:`inject-code <codeinjectionsemantics>` tag. To ease the binding developer +:ref:`inject-code <apiextractor:inject-code>` tag. To ease the binding developer work, the injected code can make use of special variables that will be replaced by the correct values. This also shields the developer from some |project| implementation specifics. @@ -59,7 +59,7 @@ Variables system), this value will be inserted in the argument list. If you want to remove the argument so completely that it doesn't appear in any form on the ``%ARGUMENT_NAMES`` replacement, don't forget to remove also its default value - with the `<remove-default-expression/>`_ type system tag. + with the :ref:`remove-default-expression <apiextractor:remove-default-expression>` type system tag. Take the following method and related type system description as an example: @@ -332,6 +332,3 @@ that expects a Python sequence instead. delete[] argv; </inject-code> </modify-function> - - -.. _`<remove-default-expression/>`: http://www.pyside.org/docs/apiextractor/typesystem_arguments.html#remove-default-expression |