aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/doc/projectfile.rst
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-04-10 10:13:40 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-04-19 18:44:47 +0000
commitc18e1958334aa2e1c40e87097dade6f103e4ddf1 (patch)
tree87adcde501a04e9c3d1c10437b267b83ca5c8563 /sources/shiboken2/doc/projectfile.rst
parentb5debb687463f77053344f1e4cd7754275e487b2 (diff)
Upgrade shiboken diagrams and documentation
Applied Qt-style to the diagrams: shapes, and colors. Removed references to Boost. Move the .rst links to the bottom of the files for better maintainability. Removed unused images and wrapped a few long lines. Aspell on the rst files. The links needs to be updated once we have the URL for the official documentation, since there are references to external documentation source directories. Task-number: PYSIDE-622 Change-Id: I2d553a29693ca4457e73a4ce5d78a2150501841d Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources/shiboken2/doc/projectfile.rst')
-rw-r--r--sources/shiboken2/doc/projectfile.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/sources/shiboken2/doc/projectfile.rst b/sources/shiboken2/doc/projectfile.rst
index 6c9808da4..aa703d941 100644
--- a/sources/shiboken2/doc/projectfile.rst
+++ b/sources/shiboken2/doc/projectfile.rst
@@ -4,9 +4,9 @@
Binding Project File
********************
-Instead of directing the Generator behaviour via command line, the binding developer
-can write a text project file describing the same information, and avoid the hassle
-of a long stream of command line arguments.
+Instead of directing the Generator behavior via command line, the binding
+developer can write a text project file describing the same information, and
+avoid the hassle of a long stream of command line arguments.
.. _project-file-structure:
@@ -34,11 +34,13 @@ Project file tags
The generator project file tags are in direct relation to the
:ref:`command line arguments <command-line>`. All of the current command line
-options provided by |project| were already seen on the :ref:`project-file-structure`,
-for new command line options provided by additional generator modules (e.g.: qtdoc,
-Shiboken) could also be used in the generator project file following simple conversion rules.
+options provided by |project| were already seen on the
+:ref:`project-file-structure`, for new command line options provided by
+additional generator modules (e.g.: qtdoc, Shiboken) could also be used in the
+generator project file following simple conversion rules.
-For tags without options, just write as an empty tag without any attributes. Example:
+For tags without options, just write as an empty tag without any attributes.
+Example:
.. code-block:: bash