<div dir="ltr">Hi Sean,<br><br><div class="gmail_extra">thanks for the hard work you spend on this.<br><br></div><div class="gmail_extra">I will upload the docs to readthedocs server.<br><br></div><div class="gmail_extra">
Thanks<br></div><div class="gmail_extra">Roman<br></div><div class="gmail_extra"><br><div class="gmail_quote">2013/11/26 Sean Fisk <span dir="ltr"><<a href="mailto:sean@seanfisk.com" target="_blank">sean@seanfisk.com</a>></span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><p style="margin:1.2em 0px!important">Hello PySiders!</p>
<p style="margin:1.2em 0px!important">After a monumental struggle I was able to achieve the goal of building the PySide and Shiboken 1.2.1 API docs. Following in the footsteps of those before me, Iíve uploaded them to <a href="http://seanfisk.github.io/pyside-docs/" target="_blank">Github Pages</a> for use by the community. Iíve also created tarballs of the documentation available for download.</p>



<p style="margin:1.2em 0px!important">Iíve gathered the build process into a Bash script which is available in <a href="https://github.com/seanfisk/pyside-docs" target="_blank">this Github repo</a>. Iíve tested it on Mac OS X and CentOS, and it should work on most UNIX-like systems. If anyone wants to hack on it, let me know if you have questions.</p>



<p style="margin:1.2em 0px!important">During the build process, I stumbled upon a couple things:</p>
<ul style="margin:1.2em 0px;padding-left:2em">
<li style="margin:0.5em 0px"><code style="font-size:0.85em;font-family:Consolas,Inconsolata,Courier,monospace;margin:0px 0.15em;padding:0px 0.3em;white-space:pre-wrap;border:1px solid rgb(234,234,234);background-color:rgb(248,248,248);border-top-left-radius:3px;border-top-right-radius:3px;border-bottom-right-radius:3px;border-bottom-left-radius:3px;display:inline">qdoc3</code> from Qt 4.6 is needed to build API docs for PySide. This is because WebXML support was buggy in Qt 4.7 and dropped in Qt 4.8, and Shiboken uses this to generate the docs (thanks Roman Lacko). This is very annoying because parts of Qt 4.6 must be configured and built for <code style="font-size:0.85em;font-family:Consolas,Inconsolata,Courier,monospace;margin:0px 0.15em;padding:0px 0.3em;white-space:pre-wrap;border:1px solid rgb(234,234,234);background-color:rgb(248,248,248);border-top-left-radius:3px;border-top-right-radius:3px;border-bottom-right-radius:3px;border-bottom-left-radius:3px;display:inline">qdoc3</code> to build correctly.</li>



<li style="margin:0.5em 0px">Shiboken has a documented <code style="font-size:0.85em;font-family:Consolas,Inconsolata,Courier,monospace;margin:0px 0.15em;padding:0px 0.3em;white-space:pre-wrap;border:1px solid rgb(234,234,234);background-color:rgb(248,248,248);border-top-left-radius:3px;border-top-right-radius:3px;border-bottom-right-radius:3px;border-bottom-left-radius:3px;display:inline">--documentation-only</code> flag but refuses to actually accept it. But Shiboken doesnít tell you which option was invalid, only that it was ďcalled with the wrong arguments.Ē This is annoying but seems like it has an easy fix.</li>



</ul>
<p style="margin:1.2em 0px!important">The documentation build process is little convoluted in general. Some of these issues seem like they are out of the hands of PySide, though.</p>
<p style="margin:1.2em 0px!important">I hope these docs are able to help somebody out there!</p>
<p style="margin:1.2em 0px!important">Thanks,</p></div><div><div><div>--</div><div>Sean Fisk</div></div>
</div></div>
<br>_______________________________________________<br>
PySide mailing list<br>
<a href="mailto:PySide@qt-project.org">PySide@qt-project.org</a><br>
<a href="http://lists.qt-project.org/mailman/listinfo/pyside" target="_blank">http://lists.qt-project.org/mailman/listinfo/pyside</a><br>
<br></blockquote></div><br></div></div>