kicad-developers team mailing list archive

[Marco Ciampa <ciampix@xxxxxxxxx>]

On Tue, Oct 28, 2014 at 12:12:52AM +0100, Guilherme Brondani Torri wrote:
> On 10/26/14, 12:17 AM, Marco Ciampa wrote:
> >On Sat, Oct 25, 2014 at 10:52:54AM -0400, Wayne Stambaugh wrote:
> >>Marco,
> >>
> >>Great work on the conversion analysis.  I finally go around to testing
> >>this and I have to say that I prefer the asciidoc format better than the
> >>markdown and rst formats for plain text readability.
> >Almost everyone does it but please consider that readability is not the
> >most important factor. As I said many people use rest because of sphinx.
> >Please consider that sphinx integrate a search javascript function into
> >the html generated, although maybe not so important.
> >
> >
> Hi there! Just a few comment of a casual user...
> 
> I am also looking for alternatives for the Qucs documentation. Our
> manuals are in mostly in LaTex which is amazing for what it does,
> but is a bit of a pain to translate.

I understand...

> I found the approach taken by OpenMOC rather interesting [1]. They
> use Sphinx and Doxygen combined. The whole documentation is
> automatically (re)generated at every commit, directly from the
> GitHub repository.

These examples are _very_ interesting indeed. We could definitely build
something similar.

> There is also this demo, [2] which combines Sphinx, Github,
> Transifex and publish in the Read the Docs. Apparently anyone with
> access to the fork can edit directly on the GitHub web editor and
> the documentation is rebuild.  I never used Transifex, but it seems
> to work very well if someone takes responsibility to sync the
> translation files from time to time.
> 
> I have yet to look for similar thinks with AsciiDoc...

Me neither but, all in all, is just html pages automatically generated
and commited into a git repo. Nothing that we couldn't afford with some
simple scripting...

> Best regards,
> Guilherme
> 
> [1] https://mit-crpg.github.io/OpenMOC/devguide/documentation.html
> http://masaori-sphinx-internationalization-example-en.readthedocs.org/en/latest/#

Anyway I will take a look at it to see if there are some interesting
details that I haven't seen...

Many thanks!

-- 


Marco Ciampa

I know a joke about UDP, but you might not get it.

+--------------------+
| Linux User  #78271 |
| FSFE fellow   #364 |
+--------------------+