[Scons-users] Sphinx builder

[Russel Winder]

On Sun, 2016-01-10 at 09:47 +0100, Saša Janiška wrote:
> On Sub, 2016-01-09 at 14:19 +0100, Dirk Bächle wrote:
> 
> > the tools index at
> > 
> >    https://bitbucket.org/scons/scons/wiki/ToolsIndex
> > 
> > lists two different Sphinx tools, 
> 
> Last updates 2001 & 2012.
> 
> 
> > and there is also a repo at
> > 
> >    https://bitbucket.org/russel/scons_sphinx
> 
> Last update is also from 2011.

I created this tool repository to collect the bits and pieces of code
off the wiki and into a repository – in my world wikis are not the
place to store source code, DVCS repositories are. However I have no
actual use for it myself, and no-one has been sending in pull requests
as far as I know.

> > All these are in a state of "external tool" (meaning that they
> > aren't
> > developed and maintained together with the core sources), 
> > and integrating them as "standard" extension would require one of
> > the
> > repo maintainers to contact the core devs. In addition to 
> > expressing his wish for his Sphinx tool to be delivered with the
> > default distributions of SCons, he would have to add proper 
> > documentation and tests with it.
> 
> Btw, I've also read discussion about changing doc toolchain for SCons
> itself and seeing you're determined to use DocBook, may I suggest to
> consider AsciiDoc(tor) which allows you to convert to DocBook and it
> is
> certainly much easier for authors to write in.
> 
> Otoh, it's interesting to note that CMake switched to rst/Sphinx for
> all
> their docs and even provide cmake-domain for Sphinx.

Since ASCIIDoc is effectively a frontend to DocBook/XML switching to
ASCIIDoctor would be a Very Good Thing™. The Apache Groovy team an the
GPars team have switched all their documentation and websites to
ASCIIDoctor.  

Personally I find ASCIIDoctor significantly easier to work with than
ReStructuredText. Either of these is almost infinitely superior to
working with DocBook/XML directly.

-- 
Russel.
=============================================================================
Dr Russel Winder      t: +44 20 7585 2200   voip: sip:russel.winder at ekiga.net
41 Buckmaster Road    m: +44 7770 465 077   xmpp: russel at winder.org.uk
London SW11 1EN, UK   w: www.russel.org.uk  skype: russel_winder

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: This is a digitally signed message part
URL: <https://pairlist4.pair.net/pipermail/scons-users/attachments/20160110/f022e84a/attachment.pgp>