[Qgis-community-team] Build users manual only?

[Alexandre Neto]

Thank you both,

I will have a look on both hints later.

Alexandre


On Wed, May 7, 2014 at 3:53 PM, Larry Shaffer <larrys at dakotacarto.com>wrote:

> Hi Alexandre,
>
> For when working on just the PyQGIS Cookbook, I made a small shell script
> [0] that applies a git diff patch [1] to the QGIS-Documentation repo, which
> adjusts the Sphinx conf.py to exclude everything but the section I am
> working on during a build, builds the docs, then reverts the patch.
>
> I do get a couple of Sphinx warnings about missing other sections when
> processing the main index, but the script is very handy to add as an
> external command in PyCharm (my reST editor), which also provides console
> output from the build run.
>
> I also use `restview $FilePath$` as an external command to quickly
> auto-preview the current .rst file in PyCharm in the restview server [2].
> Not a perfect preview, but IMO more helpful for reading how the text flows
> than just reading reST alone.
>
> Having those two commands bound to shortcut keys has really sped up my
> editing previews.
>
> [0] https://gist.github.com/dakcarto/f166cdc1135c5d34c673
> [1] https://gist.github.com/dakcarto/bd6a5b1c2dd7565918f6
> [2] https://pypi.python.org/pypi/restview
>
> Regards,
>
> Larry Shaffer
> Dakota Cartography
> Black Hills, South Dakota
>
>
> On Wed, May 7, 2014 at 4:06 AM, Richard Duivenvoorde <richard at duif.net>wrote:
>
>> On 07-05-14 10:21, Alexandre Neto wrote:
>> > Hello all,
>> >
>> > while preparing screenshots for the Users Manual, it's quite useful to
>> > build the related html and PDF to see if everything was done well. But
>> > it takes a lots of time (at least in my computer).
>> >
>> > Is there a way to just Build the Users Manual and Ignore PyQGIS Cookbook
>> > and Training Manual?
>> >
>> > Generally I simply activate the virtual environment and do "make pdf".
>>
>> Hi Alexandre,
>>
>> easiest, I think is to just remove the rst-sources (temporarily) from
>> your build directory: /QGIS-Documentation/source/docs . This will
>> already speed up your html building already because only user_manual
>> will not be read/build then.
>>
>> If you comment out or (temporarily) remove the lines for
>> pyqgis_developer_cookbook and user_manual in sources/conf.py around this
>> part:
>>
>> latex_documents = [
>>
>>   ('docs/user_manual/index', 'QGISUserGuide.tex', u'QGIS User Guide',
>> u'QGIS Project', 'manu>
>>   ('docs/pyqgis_developer_cookbook/index',
>> 'PyQGISDeveloperCookbook.tex', u'PyQGIS developer>
>>   ('docs/training_manual/index', 'QGISTrainingManual.tex', u'QGIS
>> Training Manual', u'QGIS P>
>> ]
>>
>> then the Makefile will not even be able to try to build latex/pdf stuff
>> for those docs.
>>
>> Hope this helps,
>>
>> Regards,
>>
>> Richard Duivenvoorde
>> _______________________________________________
>> Qgis-community-team mailing list for organizing community resources such
>> as documentation, translation etc..
>> Qgis-community-team at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20140507/e9347adc/attachment.html>