<div dir="ltr"><div class="markdown-here-wrapper" id="markdown-here-wrapper-367106" style><p style="margin:1.2em 0px!important">Hi Nicolas,</p>
<p style="margin:1.2em 0px!important">I’d be happy to modify the script to create the API Extractor documentation! There are two scripts in my <a href="https://github.com/seanfisk/pyside-docs">Github repository</a> - one to build the docs and the other to generate tarballs. Can you <a href="https://help.github.com/articles/fork-a-repo">fork my repo</a>, make the modifications, and <a href="https://help.github.com/articles/using-pull-requests">create a pull request</a>? Then I’ll run the scripts again and upload the results to my Github pages. If it's easier, you can just send a patch.</p>
</div><div>- Sean</div><div></div></div><div class="gmail_extra"><br clear="all"><div><div><br></div><div>--</div><div>Sean Fisk</div></div>
<br><br><div class="gmail_quote">On Mon, Dec 9, 2013 at 10:59 AM, Nicolas SAUBAT <span dir="ltr"><<a href="mailto:nicolas.saubat@imag.fr" target="_blank">nicolas.saubat@imag.fr</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div bgcolor="#FFFFFF" text="#000000">
Hi,<br>
<br>
Thank you Sean for your work regarding the documentation.<br>
A few weeks ago, I was also looking for documentation regarding
Shiboken (as a beginner I needed to start with some basic
documentation).<br>
I wasn't aware of your email, this is why I also used the sources to
build the Shiboken 1.2.1 documentation (not PySide API docs, at
least for the moment).<br>
But, I noticed the API-Extractor documentation was not built, thus I
modified the CMake configuration files in order to build it.<br>
Might it be interesting to add the missing API-Extractor
documentation to your script / personnal page ?<br>
<br>
Anyway, I built the documentation as PDF files. I attached them,
hoping they might help someone.<br>
<br>
Thanks,<br>
Nicolas.<div><div class="h5"><br>
<br>
<br>
<div>On 11/26/2013 08:12 PM, Sean Fisk
wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">Thanks, Anand, for testing the script out. Glad to
have some confirmation of it working.
<div><br>
</div>
<div>Thanks, Roman, for uploading to ReadTheDocs and for your
advice on building the docs.</div>
</div>
<div class="gmail_extra">
<br clear="all">
<div>
<div><br>
</div>
<div>--</div>
<div>Sean Fisk</div>
</div>
<br>
<br>
<div class="gmail_quote">On Tue, Nov 26, 2013 at 5:34 AM,
Gadiyar, Anand <span dir="ltr"><<a href="mailto:gadiyar@ti.com" target="_blank">gadiyar@ti.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div link="blue" vlink="purple" lang="EN-US">
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Sean,</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Thanks
for this. I’ve just used your script on an Ubuntu
box and it works well!</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">-
Anand</span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span></p>
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">
pyside-bounces+gadiyar=<a href="mailto:ti.com@qt-project.org" target="_blank">ti.com@qt-project.org</a> [mailto:<a href="mailto:pyside-bounces%2Bgadiyar" target="_blank">pyside-bounces+gadiyar</a>=<a href="mailto:ti.com@qt-project.org" target="_blank">ti.com@qt-project.org</a>]
<b>On Behalf Of </b>Roman Lacko<br>
<b>Sent:</b> Tuesday, November 26, 2013 1:58 PM<br>
<b>To:</b> Sean Fisk<br>
<b>Cc:</b> PySide<br>
<b>Subject:</b> Re: [PySide] PySide 1.2.1 API Docs</span></p>
<div>
<div>
<p class="MsoNormal"> </p>
<div>
<p class="MsoNormal" style="margin-bottom:12.0pt">Hi
Sean,</p>
<div>
<p class="MsoNormal" style="margin-bottom:12.0pt">thanks for the
hard work you spend on this.</p>
</div>
<div>
<p class="MsoNormal" style="margin-bottom:12.0pt">I will upload the
docs to readthedocs server.</p>
</div>
<div>
<p class="MsoNormal">Thanks</p>
</div>
<div>
<p class="MsoNormal">Roman</p>
</div>
<div>
<p class="MsoNormal"> </p>
<div>
<p class="MsoNormal">2013/11/26 Sean Fisk <<a href="mailto:sean@seanfisk.com" target="_blank">sean@seanfisk.com</a>></p>
<div>
<div>
<p style="margin:0px!important">Hello
PySiders!</p>
<p style="margin: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: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:0px!important">During the
build process, I stumbled upon a couple
things:</p>
<p class="MsoNormal" style="margin-left:0mm">
<span style="font-size:10.0pt;font-family:Symbol"><span>·<span>
</span></span></span><code><span style="font-size:10.0pt;font-family:Consolas;border:solid #eaeaea 1.0pt;padding:0mm;background:#f8f8f8">qdoc3</span></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><span style="font-size:10.0pt;font-family:Consolas;border:solid #eaeaea 1.0pt;padding:0mm;background:#f8f8f8">qdoc3</span></code>
to build correctly.</p>
<p class="MsoNormal" style="margin-left:0mm">
<span style="font-size:10.0pt;font-family:Symbol"><span>·<span>
</span></span></span>Shiboken has a
documented <code><span style="font-size:10.0pt;font-family:Consolas;border:solid #eaeaea 1.0pt;padding:0mm;background:#f8f8f8">--documentation-only</span></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.</p>
<p style="margin: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:0px!important">I hope
these docs are able to help somebody out
there!</p>
<p style="margin:0px!important">Thanks,</p>
</div>
<div>
<div>
<div>
<p class="MsoNormal">--</p>
</div>
<div>
<p class="MsoNormal">Sean Fisk</p>
</div>
</div>
</div>
</div>
<p class="MsoNormal" style="margin-bottom:12.0pt"><br>
_______________________________________________<br>
PySide mailing list<br>
<a href="mailto:PySide@qt-project.org" target="_blank">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></p>
</div>
<p class="MsoNormal"> </p>
</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
<br>
</div>
<br>
<fieldset></fieldset>
<br>
<pre>_______________________________________________
PySide mailing list
<a href="mailto:PySide@qt-project.org" target="_blank">PySide@qt-project.org</a>
<a href="http://lists.qt-project.org/mailman/listinfo/pyside" target="_blank">http://lists.qt-project.org/mailman/listinfo/pyside</a>
</pre>
</blockquote>
<br>
</div></div><span class="HOEnZb"><font color="#888888"><pre cols="72">--
Nicolas SAUBAT
Ingénieur Recherche et Développement
Equipe GMCAO - Laboratoire TIMC-IMAG
Pavillon Taillefer
Allée des Alpes - Domaine de la Merci
38706 La Tronche
Tel : (33)04 56 52 00 10
</pre>
</font></span></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>