couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexander Shorin (JIRA)" <>
Subject [jira] [Commented] (COUCHDB-1536) Integrate Docs into Release Process
Date Sun, 04 Nov 2012 19:54:12 GMT


Alexander Shorin commented on COUCHDB-1536:

Following my experience, to provide really good PDF build there is need to review docs very
careful for each changes since sphinx-rst2pdf doesn't respect any typography rules and at
least you'll get a big problems with page breaking (e.g. section header at the end of page,
 split code block for two pages etc.). To fix this, there is need to setup special latex page
breakers markers and check that they breaks page correctly before build release PDF version.
If you want to get PDF docs as just a fact without caring about result quality - that's ok
to go with default state. If you still care about and want to provide nice and readable PDF
docs - that's another non-trivial task to carry on, sometimes not compatible with formats.
> Integrate Docs into Release Process
> -----------------------------------
>                 Key: COUCHDB-1536
>                 URL:
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.3
>            Reporter: Dave Cottlehuber
>            Assignee: Noah Slater
>            Priority: Blocker
>              Labels: docs,, make
>             Fix For: 1.3
> List of outstanding tasks for integrating documentation into CouchDB build chain:
> - create DNS CNAME docs -> 
> - add that to quicklinks on main site
> - extend makefile to: check for sphinx-build in PATH, & do the right thing in make
> - check if that works in VPATH build
> - update wiki /Documentation as required

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see:

View raw message