aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 07:51:22 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2020-10-28 09:34:35 +0000
commit2a2a0827fa54b2eeb48e0e2090dfc503492ef33e (patch)
tree4311f7ad34ff98fabcbe4c34e59a970ae4ff4bcf /sources/pyside2/doc
parentfb1c0f204e09ba29fa3d360d72231d4ed468c1e4 (diff)
Rename shiboken2 to shiboken6
Adapt CMake files, build scripts, tests and examples. Task-number: PYSIDE-904 Change-Id: I4cb5ee4c8df539546014b08202a7b1e98ed3ff07 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside2/doc')
-rw-r--r--sources/pyside2/doc/CMakeLists.txt12
-rw-r--r--sources/pyside2/doc/conf.py.in4
-rw-r--r--sources/pyside2/doc/contents.rst2
-rw-r--r--sources/pyside2/doc/deployment-pyinstaller.rst10
-rw-r--r--sources/pyside2/doc/faq.rst12
-rw-r--r--sources/pyside2/doc/gettingstarted.rst4
-rw-r--r--sources/pyside2/doc/index.rst8
7 files changed, 26 insertions, 26 deletions
diff --git a/sources/pyside2/doc/CMakeLists.txt b/sources/pyside2/doc/CMakeLists.txt
index 73b90c059..409fde41b 100644
--- a/sources/pyside2/doc/CMakeLists.txt
+++ b/sources/pyside2/doc/CMakeLists.txt
@@ -16,12 +16,12 @@ set(TS_ROOT "${ROOT}/PySide2")
file(REMOVE ${CMAKE_CURRENT_LIST_DIR}/pyside.qdocconf ${CMAKE_CURRENT_LIST_DIR}/pyside.qdocconf.in)
-set(SHIBOKEN_INTERSPHINX_FILE "${ROOT}/pyside2/shiboken2/objects.inv")
+set(SHIBOKEN_INTERSPHINX_FILE "${ROOT}/pyside2/shiboken6/objects.inv")
set(HAS_WEBENGINE_WIDGETS 0)
set(SKIP_SPHINX_WARNINGS 1)
if (FULLDOCSBUILD)
set(SKIP_SPHINX_WARNINGS 0)
- set(SHIBOKEN_INTERSPHINX_FILE "${CMAKE_BINARY_DIR}/doc/html/shiboken2/doc/html/objects.inv")
+ set(SHIBOKEN_INTERSPHINX_FILE "${CMAKE_BINARY_DIR}/doc/html/shiboken6/doc/html/objects.inv")
# For Qt modules that are part of the documentation build:
# - Configure the module docconf file
# - Write shiboken header consisting of pyside2_global.h and module includes
@@ -131,10 +131,10 @@ add_custom_target(apidoc
# and generate offline help based on the output format.
if(DOC_OUTPUT_FORMAT STREQUAL "html")
add_custom_command(TARGET apidoc POST_BUILD
- COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/html/shiboken2
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/html/shiboken6
COMMAND ${CMAKE_COMMAND} -E copy_directory
- ${CMAKE_CURRENT_BINARY_DIR}/../../shiboken2/doc/html
- ${CMAKE_CURRENT_BINARY_DIR}/html/shiboken2
+ ${CMAKE_CURRENT_BINARY_DIR}/../../shiboken6/doc/html
+ ${CMAKE_CURRENT_BINARY_DIR}/html/shiboken6
COMMENT "Copying Shiboken docs..."
VERBATIM)
else()
@@ -151,7 +151,7 @@ configure_file("conf.py.in" "rst/conf.py" @ONLY)
add_custom_target("docrsts"
COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/rst
- COMMAND Shiboken2::shiboken2 --generator-set=qtdoc ${docHeader}
+ COMMAND Shiboken6::shiboken6 --generator-set=qtdoc ${docHeader}
--include-paths="${QT_INCLUDE_DIR}${PATH_SEP}${pyside2_SOURCE_DIR}${PATH_SEP}${TS_ROOT}"
--api-version=${SUPPORTED_QT_VERSION}
--typesystem-paths="${QDOC_TYPESYSTEM_PATH}"
diff --git a/sources/pyside2/doc/conf.py.in b/sources/pyside2/doc/conf.py.in
index ae1bc6455..ff04dcf20 100644
--- a/sources/pyside2/doc/conf.py.in
+++ b/sources/pyside2/doc/conf.py.in
@@ -173,9 +173,9 @@ html_show_sourcelink = False
# Output file base name for HTML help builder.
#htmlhelp_basename = 'PySideDoc'
-# Link to the shiboken2 sphinx project to enable linking
+# Link to the shiboken6 sphinx project to enable linking
# between the two projects.
-intersphinx_mapping = {'shiboken2': ('shiboken2','@SHIBOKEN_INTERSPHINX_FILE@')}
+intersphinx_mapping = {'shiboken6': ('shiboken6','@SHIBOKEN_INTERSPHINX_FILE@')}
add_module_names = False
diff --git a/sources/pyside2/doc/contents.rst b/sources/pyside2/doc/contents.rst
index 598a65c92..6d0b25fb7 100644
--- a/sources/pyside2/doc/contents.rst
+++ b/sources/pyside2/doc/contents.rst
@@ -14,7 +14,7 @@
licenses.rst
modules.rst
considerations.rst
- shiboken2/index.rst
+ shiboken6/index.rst
Module Index
============
diff --git a/sources/pyside2/doc/deployment-pyinstaller.rst b/sources/pyside2/doc/deployment-pyinstaller.rst
index e7ed643f6..d58ec2d7d 100644
--- a/sources/pyside2/doc/deployment-pyinstaller.rst
+++ b/sources/pyside2/doc/deployment-pyinstaller.rst
@@ -20,7 +20,7 @@ After installation, the `pyinstaller` binary is located in your virtual environm
directory, or where your Python executable is located. If that directory isn't in your `PATH`,
include the whole path when you run `pyinstaller`.
-.. warning:: If you already have a PySide2 or Shiboken2 version installed in your
+.. warning:: If you already have a PySide2 or Shiboken6 version installed in your
system path, PyInstaller uses them instead of your virtual environment version.
Freeze an application
@@ -119,7 +119,7 @@ PyInstaller Issue
-----------------
As mentioned before, if available, `PyInstaller` picks a system installation of PySide2 or
-Shiboken2 instead of your `virtualenv` version without notice. This is negligible if those
+Shiboken6 instead of your `virtualenv` version without notice. This is negligible if those
two versions are the same.
If you're working with different versions, this can result in frustrating debugging sessions
@@ -144,13 +144,13 @@ Safety Instructions
-------------------
- When using `PyInstaller` with `virtualenv`, make sure that there is no system
- installation of PySide2 or shiboken2.
+ installation of PySide2 or shiboken6.
-- Before compiling, use `pip -uninstall pyside2 shiboken2 -y` multiple times, until
+- Before compiling, use `pip -uninstall pyside2 shiboken6 -y` multiple times, until
none of the programs are found anymore.
- Pip is usually a good tool. But to be 100 % sure, you should directly remove
- the PySide2 and shiboken2 folders from site-packages.
+ the PySide2 and shiboken6 folders from site-packages.
- Be sure to use the right version of pip. The safest way to really run the right
pip, is to use the Python that you mean: Instead of the pip command, better use::
diff --git a/sources/pyside2/doc/faq.rst b/sources/pyside2/doc/faq.rst
index b7e9816c8..99721141b 100644
--- a/sources/pyside2/doc/faq.rst
+++ b/sources/pyside2/doc/faq.rst
@@ -17,21 +17,21 @@ Frequently Asked Questions
The project's old wiki page is available on PySide, but the project is now deprecated and not
supported.
-**There are three wheels (pyside2, shiboken2, and shiboken2_generator), what's the difference?**
+**There are three wheels (pyside2, shiboken6, and shiboken6_generator), what's the difference?**
Before the official release, everything was in one big wheel, so it made sense to split these
into separate wheels, each for the major projects currently in development:
* **pyside2**: contains all the PySide2 modules to use the Qt framework; also depends on the
- shiboken2 module.
- * **shiboken2**: contains the shiboken2 module with helper functions for PySide2.
- * **shiboken2_generator**: contains the generator binary that can work with a C++ project and a
+ shiboken6 module.
+ * **shiboken6**: contains the shiboken6 module with helper functions for PySide2.
+ * **shiboken6_generator**: contains the generator binary that can work with a C++ project and a
typesystem to generate Python bindings.
If you want to generate bindings for a Qt/C++ project, there won't be any linking to the Qt
shared libraries; you need to do this by hand. We recommend building PySide2 from scratch
to have everything properly linked.
-**Why is the shiboken2_generator not installed automatically?**
- It's not necessary to install the shiboken2_generator to use PySide2. The package is a result of
+**Why is the shiboken6_generator not installed automatically?**
+ It's not necessary to install the shiboken6_generator to use PySide2. The package is a result of
the wheel splitting process. To use the generator, it's recommended to build it from scratch to
have the proper Qt linking.
diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst
index 1623538cf..44320b25f 100644
--- a/sources/pyside2/doc/gettingstarted.rst
+++ b/sources/pyside2/doc/gettingstarted.rst
@@ -108,7 +108,7 @@ which will generate a ``html/`` directory with the following structure::
└── pyside2
├── index.html
├── ...
- └── shiboken2
+ └── shiboken6
├── index.html
└── ...
@@ -148,7 +148,7 @@ directory, and run::
Finally, you will get a ``html`` directory containing all the generated documentation. The offline
help files, ``PySide.qch`` and ``Shiboken.qch``, can be moved to any directory of your choice. You
-can find ``Shiboken.qch`` in the build directory, ``*_build\*_release\shiboken2\doc\html``.
+can find ``Shiboken.qch`` in the build directory, ``*_build\*_release\shiboken6\doc\html``.
Viewing offline documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst
index 6c62334d5..5a4941afd 100644
--- a/sources/pyside2/doc/index.rst
+++ b/sources/pyside2/doc/index.rst
@@ -7,7 +7,7 @@
has two main components:
* `PySide2`_, so that you can use Qt5 APIs in your Python applications, and
- * `Shiboken2 <shiboken2/index.html>`__, a binding generator tool, which can
+ * `Shiboken6 <shiboken6/index.html>`__, a binding generator tool, which can
be used to expose C++ projects to Python, and a Python module with
some utility functions.
@@ -17,7 +17,7 @@
has two main components:
* `PySide2`_, so that you can use Qt5 APIs in your Python applications, and
- * `Shiboken2 <../shiboken2/index.html>`__, a binding generator tool, which can
+ * `Shiboken6 <../shiboken6/index.html>`__, a binding generator tool, which can
be used to expose C++ projects to Python, and a Python module with
some utility functions.
@@ -57,7 +57,7 @@ Documentation
<tr>
<td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
<td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
- <td><a href="shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
+ <td><a href="shiboken6/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
</tr>
</table>
@@ -86,7 +86,7 @@ Documentation
<tr>
<td><a href="deployment.html" style="display: block;"><p><strong>Deployment</strong><br/>Learn to deploy your apps.</p></a></td>
<td><a href="considerations.html" style="display: block;"><p><strong>Considerations</strong><br/>API differences and known issues.</p></a></td>
- <td><a href="../shiboken2/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
+ <td><a href="../shiboken6/index.html" style="display: block;"><p><strong>Shiboken</strong><br/>Generate C++ to Python binding.</p></a></td>
</tr>
</table>