Menu

#2931 WinMerge Developer Cookbook with reST + Sphinx

Not Scheduled
open
nobody
Docs (328)
5
2013-03-02
2010-02-06
Tim Gerundt
No

I tried to convert our developer readme's files to a Sphinx <http://sphinx.pocoo.org/> project with text files in the reST markup <http://en.wikipedia.org/wiki/ReStructuredText>, like disscued in the forum:

Using reST + Sphinx for documentation?
http://sourceforge.net/apps/phpbb/winmerge/viewtopic.php?f=6&t=147

This is a really *raw* version, I created with a html2rst python script I found in the web. But it is a start and we can look, if we like such a Sphinx docu! The name "Cookbook" is of course changeable. ;)

Just unzip "cookbook-src.7z" and call "make.bat html" or "make-html.bat" after you have Python and Sphinx installed. You find the HTML version in the "_build\html" folder.

Greetings,
Tim

Discussion

  • Tim Gerundt

    Tim Gerundt - 2010-02-06

    reST source files

     
  • Tim Gerundt

    Tim Gerundt - 2010-02-06

    HTML output

     
  • Christian List

    Christian List - 2013-03-02
    • milestone: Trunk --> Not Scheduled
     

Log in to post a comment.