Failed to build doc for pyside6 in qch by following the doc

[jronald]

@friedemannkleint said in Failed to build doc for pyside6 in qch by following the doc:

If you want the full API docs, you need to build PySide 6 yourself, as described in the getting started page.

I've built it in pyside-setup/out/, how to use it?

$ python setup.py build_rst_docs --build-docs --qtpaths=/usr/lib/qt6/bin/qtpaths --qt=6 --qt-src-dir=/path/to/qt6/qtbase
...
This build process will not include the API documentation.API documentation requires a full build of pyside/shiboken.
...

[friedemannkleint]

Have you checked https://doc.qt.io/qtforpython-6/gettingstarted.html ? Do you have libxml, libxslt (dev packages) and graphviz installed? You then need to go to the build directory (something like build/testenv_td/build/pyside6) and then run ninja apidoc as described.

[jronald]

@friedemannkleint said in Failed to build doc for pyside6 in qch by following the doc:

Have you checked https://doc.qt.io/qtforpython-6/gettingstarted.html ?

Yes, I've read it several times.

Do you have libxml, libxslt (dev packages) and graphviz installed?

Yes

You then need to go to the build directory (something like build/testenv_td/build/pyside6) and then run ninja apidoc as described.

I can't find the directory.

---

UPDATE

Now using python setup.py install ... instead of cmake to build, it seems ok, in progress.

$ python setup.py install --build-docs --qtpaths=/usr/lib/qt6/bin/qtpaths --qt-src-dir=/path/to/qt6/qtbase --ignore-git --parallel=8

[jronald]

New error

$ ninja apidoc
...
qtpaths: Unknown options: q, u, e, r, y.
Traceback (most recent call last):
  File "/path/to/pyside-setup/sources/pyside6/doc/qtattributionsscannertorst.py", line 102, in <module>
    runScanner(directory, targetFileName)
  File "/path/to/pyside-setup/sources/pyside6/doc/qtattributionsscannertorst.py", line 67, in runScanner
    libexec_b = subprocess.check_output('qtpaths -query QT_INSTALL_LIBEXECS',
  File "/usr/lib/python3.10/subprocess.py", line 421, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/usr/lib/python3.10/subprocess.py", line 526, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command 'qtpaths -query QT_INSTALL_LIBEXECS' returned non-zero exit status 1.
ninja: build stopped: subcommand failed.

[JonB]

@jronald said in Failed to build doc for pyside6 in qch by following the doc:

qtpaths: Unknown options: q, u, e, r, y.

Command 'qtpaths -query QT_INSTALL_LIBEXECS' returned non-zero exit status 1.

I know nothing about why this happening/what you are supposed to do about it, but that sounds like something is invoking qtpaths -query when it only accepts qtpaths --query? Try both of these from the command line to see if that is the cause of the error message?

[jronald]

@JonB said in Failed to build doc for pyside6 in qch by following the doc:

I know nothing about why this happening/what you are supposed to do about it, but that sounds like something is invoking qtpaths -query when it only accepts qtpaths --query? Try both of these from the command line to see if that is the cause of the error message?

$ /usr/lib/qt6/bin/qtpaths --query QT_INSTALL_LIBEXECS
/usr/lib/qt6

It's a bug in /path/to/pyside-setup/sources/pyside6/doc/qtattributionsscannertorst.py:

libexec_b = subprocess.check_output('qtpaths -query QT_INSTALL_LIBEXECS',
                                    shell=True)

The codes below also don't work, because qtpaths here is for qt5 and it doesn't support --query,
qtpaths here should be controlled by the command param --qtpaths

libexec_b = subprocess.check_output('qtpaths --query QT_INSTALL_LIBEXECS',
                                    shell=True)

The codes below work as a temp solution.

libexec_b = subprocess.check_output('/usr/lib/qt6/bin/qtpaths --query QT_INSTALL_LIBEXECS',
                                    shell=True)

[jronald]

screenshot

[jronald]

Summary

pyside-setup-path=...
venv-name=...
venv-prefix=...
venv-path=${venv-prefix}/${venv-name}
qtpaths-exe-path=... # e.g. /usr/lib/qt6/bin/qtpaths
qt-src-path=... # qtbase path in source tree, e.g. /path/to/qt6-src/qtbase

python -m venv ${venv-path}
source ${venv-path}/bin/activate

cd ${venv-path}

pip install -r requirements.txt
pip install graphviz

# build pyside6 doc
cd ${pyside-setup-path}
python ./setup.py build_rst_docs

# build api doc
python setup.py install --build-docs --qtpaths=${qtpaths_exe_path} --qt-src-dir=${qt-src-path} --ignore-git --parallel=8

cd ${pyside-setup-path}/build/${venv-name}/build/pyside6
ninja apidoc
# Result: ${pyside-setup-path}/build/${venv-name}/build/pyside6/doc/html/PySide.qch

Bug fix (manjaro)

file

/path/to/pyside-setup/sources/pyside6/doc/qtattributionsscannertorst.py

buggy codes

libexec_b = subprocess.check_output('qtpaths -query QT_INSTALL_LIBEXECS',
                                    shell=True)

fix

libexec_b = subprocess.check_output('/usr/lib/qt6/bin/qtpaths --query QT_INSTALL_LIBEXECS',
                                    shell=True)

[friedemannkleint]

The qtattributionsscannertorst.py error will be fixed by https://codereview.qt-project.org/c/pyside/pyside-setup/+/442370 , hopefully. As for missing links, did you really pass a Qt source tree - --qt-src-dir=/path/to/qt6/qtbase does not look like it. We use qdoc which needs the source tree.

[jronald]

@friedemannkleint said in Failed to build doc for pyside6 in qch by following the doc:

As for missing links, did you really pass a Qt source tree - --qt-src-dir=/path/to/qt6/qtbase does not look like it.

Yes, in practice I'm using a real path to qt6/qtbase instead of /path/to/qt6/qtbase as a placeholder here.