diff options
author | Cristián Maureira-Fredes <[email protected]> | 2024-01-06 01:59:49 +0100 |
---|---|---|
committer | Cristián Maureira-Fredes <[email protected]> | 2024-01-08 13:05:30 +0100 |
commit | 2ff4524802b90be37c10662593b5060af86d338f (patch) | |
tree | 15386f9ffaeb296b6b447bb5a88e97aced04e458 /sources/pyside6/doc/developer | |
parent | 09ce3bf16a6b624034986e07399f487a5eafa396 (diff) |
doc: fix some issues found with rstcheck
Checking the local rst files, we had some issues
related to repeated links, bad syntax of code-blocks,
invalid levels, etc.
Pick-to: 6.6
Change-Id: I94d64d9cca5142833640f30299d1ad32b568f7ad
Reviewed-by: Friedemann Kleint <[email protected]>
Diffstat (limited to 'sources/pyside6/doc/developer')
-rw-r--r-- | sources/pyside6/doc/developer/documentation.rst | 1 | ||||
-rw-r--r-- | sources/pyside6/doc/developer/feature-motivation.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/developer/signature_doc.rst | 2 |
3 files changed, 3 insertions, 2 deletions
diff --git a/sources/pyside6/doc/developer/documentation.rst b/sources/pyside6/doc/developer/documentation.rst index 1ebfc18c5..517bd46f1 100644 --- a/sources/pyside6/doc/developer/documentation.rst +++ b/sources/pyside6/doc/developer/documentation.rst @@ -69,4 +69,5 @@ There are 2 scripts used for determining the inheritance: * ``json_inheritance.py`` (env var ``INHERITANCE_FILE``) reads a inheritance.json file containing the class hierarchy generated by shiboken's doc generator. + * ``import_inheritance.py`` actually tries to import the class (legacy) diff --git a/sources/pyside6/doc/developer/feature-motivation.rst b/sources/pyside6/doc/developer/feature-motivation.rst index ea0cede51..1509ea724 100644 --- a/sources/pyside6/doc/developer/feature-motivation.rst +++ b/sources/pyside6/doc/developer/feature-motivation.rst @@ -286,7 +286,7 @@ When using ``__feature__`` often with common IDEs, you may want to provide a feature-aware version of ``.pyi`` files to get a correct display. The simplest way to change them all in-place is the command: -.. code-block:: python +.. code-block:: bash pyside6-genpyi all --feature snake_case true_property diff --git a/sources/pyside6/doc/developer/signature_doc.rst b/sources/pyside6/doc/developer/signature_doc.rst index c81e9a559..a6c703dab 100644 --- a/sources/pyside6/doc/developer/signature_doc.rst +++ b/sources/pyside6/doc/developer/signature_doc.rst @@ -318,7 +318,7 @@ A shortcut for this command is ``pyside6-genpyi``. A useful command to change all .pyi files to use all features is -.. code-block:: python +.. code-block:: bash pyside6-genpyi all --feature snake_case true_property |