GitHub - michael-lehn/DocTool: Write C++ tutorials and documentation in a restructured text dialect and convert it to HTML. In particular the scripts execute your example code and include their output into the produced HTML code.

michael-lehn / DocTool Public

Notifications You must be signed in to change notification settings
Fork 3
Star 14

Write C++ tutorials and documentation in a restructured text dialect and convert it to HTML. In particular the scripts execute your example code and include their output into the produced HTML code.

View license

14 stars 3 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 27 Commits
Configuration		Configuration
CxxTools		CxxTools
Examples		Examples
Executables		Executables
Library		Library
Templates		Templates
LICENSE		LICENSE
README		README

Repository files navigation

=======
DocTool
=======

Getting started:

    https://www.mathematik.uni-ulm.de/~lehn/DocTool

(Simple) Video-Tutorial:
    https://www.youtube.com/watch?v=Yiyszxw8feY


Purpose
=======
The original purpose of this tool is writing the documentation and tutorials
for the FLENS project:

    https://www.mathematik.uni-ulm.de/~lehn/FLENS/

You can write documentation in a restructured text dialect and doctool will
produce html.  For example

    https://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/lapack/lapack.doc.txt

will result in

    https://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/lapack/lapack.html

The nice thing is that you can embed shell scripts and C++ code in your
documents and doctool will execute them and include the output into the HTML.
For example

    https://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/examples/lapack-getrf.doc.txt

will result in

    https://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/examples/lapack-getrf.html

About

Write C++ tutorials and documentation in a restructured text dialect and convert it to HTML. In particular the scripts execute your example code and include their output into the produced HTML code.