[GNC-dev] Porting the Tutorial & Concepts Guide to ReadTheDocs.org

Frank H. Ellenberger frank.h.ellenberger at gmail.com
Wed May 6 04:54:55 EDT 2020


I have started to create
https://wiki.gnucash.org/wiki/Documentation_Requirements because I
think, the bug report together with mails on several lists are becoming

In a first step we should collect required and desired criterias.
In a secound step we should see which source languages would fulfill
them how far.


Am 25.04.20 um 20:16 schrieb Rob Gowin:
>> On Apr 25, 2020, at 2:24 AM, Geert Janssens <geert.gnucash at kobaltwit.be> wrote:
>> Hi Rob,
>> Thanks for running this experiment.
>> The stylesheet used by ReadTheDocs is much more modern than ours and indeed looks much nicer for online consumption. Even the pdf is cleaner.
>> On the other hand I also have a few concerns/questions:
>> 1. How would a translation flow look like with asciidoc ?
>> 2. Can it support a single master document including sections that should only appear for certain translations ?
>> 3. ReadTheDocs is a hosted service. That's a big change from our current philosophy to self-host as much as possible. Are there self-hosting options ?
>> Regards,
>> Geert
> Hi Geert, 
> First off, yes, the documentation can be self hosted. I’ve done that here: https://gnucash-docs-test.codesmythe.net/index.html <https://gnucash-docs-test.codesmythe.net/index.html>. It uses an older stylesheet, so looks a little different, and there’s no PDF there. I have generated a PDF similar to the ReadTheDocs one locally. Note that this experiment uses files in the reStructuredText format, not asciidoc. The reST files are generated from the DocBook files using pandoc.
> For translation: The underlying tool used by ReadTheDocs is the Sphinx Python Doc Generation Project. Their I18N flow is described here: http://www.sphinx-doc.org/en/master/usage/advanced/intl.html <http://www.sphinx-doc.org/en/master/usage/advanced/intl.html>. I’m no expert in the area, but seems it does support a single master document. I don’t know about sections that should only appear for certain translations.
> I’ll jump on IRC sometime this week to discuss translations in more detail. 
> Regards,
> Rob
> _______________________________________________
> gnucash-devel mailing list
> gnucash-devel at gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel

More information about the gnucash-devel mailing list