Here is an updated status of the bug:

There is a git repository in [1] with festival-doc. I have added myself as
a maintainer, and I will maintain both festival-doc and speech-tools-doc
until they are merged into festival and speech-tools (which I help
maintaining as part of the Text To Speech group).

Regarding festival-doc, a patch is ready to generate HTML and PS
documentation from festival sources, so I have removed festival-doc from
the src:festival-doc debian/control and debian/rules files.

Regarding speech-tools-doc, due to the doc++ to doxygen change, my current
and almost final patch states:
226 changed files with 16087 additions and 11335 deletions.

I have submitted this patch upstream, and they gave me a big thank you
(they could not build speech-tools documentation either). Upstream said
they are going to merge it and include it in their next release, hopefully
soon.


All this said, this is my first adoption of an orphaned package, so if I
have forgotten any step, or done any wrong thing please feel free to
correct me.


[1] http://anonscm.debian.org/gitweb/?p=tts/festival-doc.git;a=summary




2013/8/3 Sergio Oller <sergiol...@gmail.com>

> I will try to push this bug forward:
>
> festival-doc source package builds two packages: festival-doc and
> speech-tools-doc. Once we have a build system working for both packages, I
> suggest Jean-Philippe intends to adopt festival-doc source package (or the
> TTS team adopts it, I don't know :-) ).
>
> Here is the status of building both packages from festival and
> speech-tools sources:
>
> Regarding festival-doc:
> ===================
> I have managed to successfully build festival-doc from the festival source
> package using texi2html.
> As Ryan Kavanagh pointed to Peter, there is a transition from texi2html to
> texinfo [1]. Until I have properly replaced texi2html with texinfo I will
> not commit any patch unless you prefer to have a texi2html temporal
> solution.
>
> I have to read how to replace texi2html with texinfo, I hope it is not
> going to be hard, given that many people may have done this transition
> before :-)
>
>
> Regarding speech-tools-doc:
> =====================
> Building speech-tools-doc from src:speech-tools is not trivial.
>
> Current issues:
> ----------------------
>
>  - It depends on Doc++ (an automatic documentation program not updated
> since 2003 [2] and removed from debian repository [3]).
>  - It depends on jade which seems to be being replaced by openjade because
> (according to jade's changelog [4] and jade's website [5]) it has not
> received any upstream update since 1999.
>  - The manual is in DocBook V3.0 and quite integrated with Doc++ specific
> XML output format.
>
>
> Proposed solution: (I am working on it now)
> --------------------------
> - Replace Doc++ with Doxygen. Doxygen is quite standard for source
> documentation nowadays. It can provide output in HTML and PDF formats and
> initially it was partially based on Doc++ [6], so its syntax is quite
> similar.
> - Replace the sgml manual with markdown pages. Doxygen is markdown
> friendly and this change would allow us to integrate the manual with the
> source code documentation and build everything together (with links from
> the manual to the source documentation, etc...).
>
> * Pros:
> - The proposed solution would drop all documentation dependencies (doc++,
> jade, perl...) and only leave doxygen, which seems to have good support and
> is a very active project with many users.
> - The Makefile will be much simpler.
> - Markdown format is extensively used in many projects and very easy to
> read in raw format.
>
> * Cons:
> - Converting sgml pages to markdown may lead to a patch of considerable
> size. I will try to estimate its size ASAP.
>
>
>
>
> As always, alternative solutions, comments, likes/dislikes are very
> welcome :-)
>
>
> References:
> ===========
> [1] http://lists.debian.org/debian-devel/2013/05/msg01580.html
> [2] http://sourceforge.net/projects/docpp/files/doc%2B%2B/
> [3] http://packages.qa.debian.org/d/doc++.html
> [4]
> http://ftp-master.metadata.debian.org/changelogs//main/j/jade/jade_1.2.1-47.3_changelog
> [5] http://www.jclark.com/jade/
> [6] http://www.stack.nl/~dimitri/doxygen/#acknowledgements
>
>

Reply via email to