diff options
author | Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2020-09-28 16:28:56 +0200 |
---|---|---|
committer | Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2020-09-29 01:16:44 +0200 |
commit | 50247e7d4a67e892a85dff7472f889bac97c91c7 (patch) | |
tree | 7eb2a9ec2153fdb03b367ea6eaac038922c19b54 | |
parent | 4b091251714aa16de912ef8fd9fed0f452ddf1f8 (diff) |
doc: fix more sphinx warnings
Change-Id: I07a87ad49546534f3492b534b2a2dd4945304de7
Reviewed-by: Christian Tismer <tismer@stackless.com>
-rw-r--r-- | sources/pyside2/doc/deployment.rst | 2 | ||||
-rw-r--r-- | sources/pyside2/doc/faq.rst | 4 | ||||
-rw-r--r-- | sources/pyside2/doc/gettingstarted.rst | 3 | ||||
-rw-r--r-- | sources/pyside2/doc/index.rst | 4 | ||||
-rw-r--r-- | sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst | 2 | ||||
-rw-r--r-- | sources/shiboken2/doc/index.rst | 4 | ||||
-rw-r--r-- | sources/shiboken2/doc/typesystem_manipulating_objects.rst | 2 | ||||
-rw-r--r-- | sources/shiboken2/doc/typesystem_sequenceprotocol.rst | 2 |
8 files changed, 13 insertions, 10 deletions
diff --git a/sources/pyside2/doc/deployment.rst b/sources/pyside2/doc/deployment.rst index 414a468ed..3d6aa218e 100644 --- a/sources/pyside2/doc/deployment.rst +++ b/sources/pyside2/doc/deployment.rst @@ -101,7 +101,7 @@ these tools don't offer a mechanism to update your application packages. To create update packages, use the `PyUpdater <https://www.pyupdater.org/>`_, which is a tool built around PyInstaller. -The `fbs <https://build-system.fman.io>`_ tool offers a nice UI for the user to install the +The `fbs`_ tool offers a nice UI for the user to install the application step-by-step. .. note:: diff --git a/sources/pyside2/doc/faq.rst b/sources/pyside2/doc/faq.rst index f1aa3ebcc..b7e9816c8 100644 --- a/sources/pyside2/doc/faq.rst +++ b/sources/pyside2/doc/faq.rst @@ -1,3 +1,7 @@ +.. _faq: + +:orphan: + Frequently Asked Questions ========================== diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst index b8d6f9e45..197657493 100644 --- a/sources/pyside2/doc/gettingstarted.rst +++ b/sources/pyside2/doc/gettingstarted.rst @@ -7,10 +7,9 @@ with ``pip`` you need to run:: pip install pyside2 for more details, refer to our `Quick Start`_ guide. Additionally, you can -check the `FAQ`_ related to the project. +check the :ref:`FAQ <faq>` related to the project. .. _Quick Start: quickstart.html -.. _FAQ: faq.html General Requirements -------------------- diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst index 289a653f3..ed5aeb6b4 100644 --- a/sources/pyside2/doc/index.rst +++ b/sources/pyside2/doc/index.rst @@ -5,13 +5,13 @@ **Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_), so that you can use Qt5 APIs in your Python applications, and a binding generator tool - (`Shiboken2 <shiboken2/index.html>`_) which can be used to expose C++ projects into Python. + (`Shiboken2 <shiboken2/index.html>`__) which can be used to expose C++ projects into Python. .. ifconfig:: output_format == 'qthelp' **Qt for Python** offers the official Python bindings for `Qt`_ (`PySide2`_), so that you can use Qt5 APIs in your Python applications, and a binding generator tool - (`Shiboken2 <../shiboken2/index.html>`_) which can be used to expose C++ projects into Python. + (`Shiboken2 <../shiboken2/index.html>`__) which can be used to expose C++ projects into Python. |project| is available under the LGPLv3/GPLv3 and the Qt commercial license. diff --git a/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst b/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst index 71b254811..6d7db9ef5 100644 --- a/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst +++ b/sources/pyside2/doc/tutorials/portingguide/chapter3/chapter3.rst @@ -34,7 +34,7 @@ C++ version .. literalinclude:: bookwindow.cpp :language: c++ :linenos: - :lines: 47-115 + :lines: 57-140 Python version --------------- diff --git a/sources/shiboken2/doc/index.rst b/sources/shiboken2/doc/index.rst index a6e1bccd4..ebde8d1ff 100644 --- a/sources/shiboken2/doc/index.rst +++ b/sources/shiboken2/doc/index.rst @@ -3,11 +3,11 @@ Shiboken .. ifconfig:: output_format == 'html' - Shiboken is a fundamental piece on the `Qt for Python <../index.html>`_ project that serves two purposes: + Shiboken is a fundamental piece on the `Qt for Python <../index.html>`__ project that serves two purposes: .. ifconfig:: output_format == 'qthelp' - Shiboken is a fundamental piece on the `Qt for Python <../pyside2/index.html>`_ project that serves two purposes: + Shiboken is a fundamental piece on the `Qt for Python <../pyside2/index.html>`__ project that serves two purposes: * Generator_: Extract information from C or C++ headers and generate CPython_ code that allow diff --git a/sources/shiboken2/doc/typesystem_manipulating_objects.rst b/sources/shiboken2/doc/typesystem_manipulating_objects.rst index fb0a50aba..d87b816a3 100644 --- a/sources/shiboken2/doc/typesystem_manipulating_objects.rst +++ b/sources/shiboken2/doc/typesystem_manipulating_objects.rst @@ -206,7 +206,7 @@ add-function Within the signature, names for the function parameters can be specified by enclosing them within the delimiter *@*: - .. code-block:: c++ + .. code-block:: void foo(int @parameter1@,float) diff --git a/sources/shiboken2/doc/typesystem_sequenceprotocol.rst b/sources/shiboken2/doc/typesystem_sequenceprotocol.rst index 26ae3b220..742be3d70 100644 --- a/sources/shiboken2/doc/typesystem_sequenceprotocol.rst +++ b/sources/shiboken2/doc/typesystem_sequenceprotocol.rst @@ -22,7 +22,7 @@ function with parameters and return type defined by the table above. The function needs to follow the same semantics of the *CPython equivalent* function, the only way to do it is using the -:doc:`inject-code <codeinjectionsemantics>` tag. +:ref:`inject-code <codeinjectionsemantics>` tag. A concrete example how to add sequence protocol support to a class can be found on shiboken tests, more precisely in the definition of the Str class in |