-
Notifications
You must be signed in to change notification settings - Fork 3
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.
License
michael-lehn/DocTool
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
=======
DocTool
=======
Getting started:
http://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:
http://www.mathematik.uni-ulm.de/~lehn/FLENS/
You can write documentation in a restructured text dialect and doctool will
produce html. For example
http://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/lapack/lapack.doc.txt
will result in
http://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
http://www.mathematik.uni-ulm.de/~lehn/FLENS/flens/examples/lapack-getrf.doc.txt
will result in
http://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.
Resources
License
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published