Project

General

Profile

Forums » Help »

How to generate documentation in 'tutorial' directory?

Added by Plug Gulp over 6 years ago

Hi Wt Team,

How do I generate documentation in the 'tutorial' directory? I was able to generate documentation for 'references' and 'examples' by issuing the 'make doc' command. But the files in the 'tutorial' directory are not processed; they are still in the "raw" format. How do I convert these files, wt.doc, dbo.doc and auth.doc, into the final documentation?

Thanks and kind regards,

~Plug


Replies (4)

RE: How to generate documentation in 'tutorial' directory? - Added by Roel Standaert over 6 years ago

You need to have asciidoc installed. If CMake can find asciidoc, the documentation for the tutorials will also be generated.

RE: How to generate documentation in 'tutorial' directory? - Added by Plug Gulp over 6 years ago

Roel Standaert wrote:

You need to have asciidoc installed. If CMake can find asciidoc, the documentation for the tutorials will also be generated.

Thank you!

RE: How to generate documentation in 'tutorial' directory? - Added by Plug Gulp over 6 years ago

Roel Standaert wrote:

You need to have asciidoc installed. If CMake can find asciidoc, the documentation for the tutorials will also be generated.

After installing asciidoc the documentation for tutorial is still not generated. I installed asciidoc, then ran 'cmake ..' and then 'make' and 'make doc'. The 'tutorial' directory does not contain .html files.

Thanks and kind regards,

~Plug

RE: How to generate documentation in 'tutorial' directory? - Added by Plug Gulp over 6 years ago

Okay, I got this working now. In addition to asciidocs, python-pygments is also required. I had that missing on my system.

Thanks and kind regards,

~Plug

    (1-4/4)