Great, thanks Nicolas!
-- Sean Fisk On Fri, Dec 20, 2013 at 9:31 AM, Nicolas SAUBAT <[email protected]>wrote: > Thanks Sean, > > I've also put links in the PySide wiki page to your online documentation. > Hope that would help people looking for documentations ! > > Nicolas. > > > On 12/19/2013 08:57 PM, Sean Fisk wrote: > > Hi everyone, > > Thanks to Nicolas’ work, we’ve added the ApiExtractor documentation to the > site <http://seanfisk.github.io/pyside-docs/>! Thanks for the pull > request, Nicolas. > > Sincerely, > > > -- > Sean Fisk > > > On Thu, Dec 12, 2013 at 10:56 AM, Nicolas SAUBAT > <[email protected]>wrote: > >> Hi Sean, >> >> I've followed your advices and made a pull-request with a little add-on >> to your (nice) build-docs script: >> * patched Shiboken repository to modify CMakeLists.txt files in order to >> get back apiextractor build documentation target >> * build both shiboken and api_extractor targets in your script >> >> The documentation are located in >> prefix/src/shiboken/build/[ApiExtractor]/doc/html. >> >> As it was my first experience with both Linux diff-patch and git, let me >> know if I made some mistakes with your script ! >> >> Thanks again, >> Nicolas. >> >> >> On 12/10/2013 03:45 AM, Sean Fisk wrote: >> >> Hi Nicolas, >> >> I’d be happy to modify the script to create the API Extractor >> documentation! There are two scripts in my Github >> repository<https://github.com/seanfisk/pyside-docs>- one to build the docs >> and the other to generate tarballs. Can you fork >> my repo <https://help.github.com/articles/fork-a-repo>, make the >> modifications, and create a pull >> request<https://help.github.com/articles/using-pull-requests>? >> 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. >> - Sean >> >> >> -- >> Sean Fisk >> >> >> On Mon, Dec 9, 2013 at 10:59 AM, Nicolas SAUBAT >> <[email protected]>wrote: >> >>> Hi, >>> >>> Thank you Sean for your work regarding the documentation. >>> A few weeks ago, I was also looking for documentation regarding Shiboken >>> (as a beginner I needed to start with some basic documentation). >>> 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). >>> But, I noticed the API-Extractor documentation was not built, thus I >>> modified the CMake configuration files in order to build it. >>> Might it be interesting to add the missing API-Extractor documentation >>> to your script / personnal page ? >>> >>> Anyway, I built the documentation as PDF files. I attached them, hoping >>> they might help someone. >>> >>> Thanks, >>> Nicolas. >>> >>> >>> >>> On 11/26/2013 08:12 PM, Sean Fisk wrote: >>> >>> Thanks, Anand, for testing the script out. Glad to have some >>> confirmation of it working. >>> >>> Thanks, Roman, for uploading to ReadTheDocs and for your advice on >>> building the docs. >>> >>> >>> -- >>> Sean Fisk >>> >>> >>> On Tue, Nov 26, 2013 at 5:34 AM, Gadiyar, Anand <[email protected]> wrote: >>> >>>> Sean, >>>> >>>> >>>> >>>> Thanks for this. I’ve just used your script on an Ubuntu box and it >>>> works well! >>>> >>>> >>>> >>>> - Anand >>>> >>>> >>>> >>>> *From:* [email protected] [mailto: >>>> [email protected]] *On Behalf Of *Roman >>>> Lacko >>>> *Sent:* Tuesday, November 26, 2013 1:58 PM >>>> *To:* Sean Fisk >>>> *Cc:* PySide >>>> *Subject:* Re: [PySide] PySide 1.2.1 API Docs >>>> >>>> >>>> >>>> Hi Sean, >>>> >>>> thanks for the hard work you spend on this. >>>> >>>> I will upload the docs to readthedocs server. >>>> >>>> Thanks >>>> >>>> Roman >>>> >>>> >>>> >>>> 2013/11/26 Sean Fisk <[email protected]> >>>> >>>> Hello PySiders! >>>> >>>> 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 Github >>>> Pages<http://seanfisk.github.io/pyside-docs/>for use by the community. >>>> I’ve also created tarballs of the documentation >>>> available for download. >>>> >>>> I’ve gathered the build process into a Bash script which is available >>>> in this Github repo <https://github.com/seanfisk/pyside-docs>. 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. >>>> >>>> During the build process, I stumbled upon a couple things: >>>> >>>> · qdoc3 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 >>>> qdoc3 to build correctly. >>>> >>>> · Shiboken has a documented --documentation-only 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. >>>> >>>> The documentation build process is little convoluted in general. Some >>>> of these issues seem like they are out of the hands of PySide, though. >>>> >>>> I hope these docs are able to help somebody out there! >>>> >>>> Thanks, >>>> >>>> -- >>>> >>>> Sean Fisk >>>> >>>> >>>> _______________________________________________ >>>> PySide mailing list >>>> [email protected] >>>> http://lists.qt-project.org/mailman/listinfo/pyside >>>> >>>> >>>> >>> >>> >>> >>> _______________________________________________ >>> PySide mailing >>> [email protected]http://lists.qt-project.org/mailman/listinfo/pyside >>> >>> >>> -- >>> 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 >>> >>> >>> _______________________________________________ >>> PySide mailing list >>> [email protected] >>> http://lists.qt-project.org/mailman/listinfo/pyside >>> >>> >> >> -- >> 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 >> >> > > -- > 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 > >
_______________________________________________ PySide mailing list [email protected] http://lists.qt-project.org/mailman/listinfo/pyside
