jessevdk / cldoc

clang based documentation generator for C and C++
GNU General Public License v2.0
553 stars 59 forks source link

markdown? #97

Closed rhl- closed 9 years ago

rhl- commented 9 years ago

I wrote two markdown files similar to the tutorial and ran:

$ cldoc generate -std=c++11 -I/Users/rhl/code/ctl -- --output=./doc --merge=./doc/markdown $(cat header_file_names)

But the markdown doesn't "just appear" when I type 'cldoc serve' its not clear to me what I am doing wrong. There appears to be no errors..

jessevdk commented 9 years ago

Please paste the markdown.

rhl- commented 9 years ago

$ cat index.md

cldoc:index

CTL: The Computational Topology Library

Documentation

This page lists the complete functionality of CTL. It is compiled automatically from the source code.

$ cat ctl.md

cldoc:ctl

The entire library lives within the CTL namespace.

jessevdk commented 9 years ago

As a test, I update the example/docs/index.md with your pasted index.md and example/docs/transport.md with your ctl.md. Run the doc generation, this works. The merged in markdown shows up as expected. Does any merged doc show up in the generated xml/index.xml ?

rhl- commented 9 years ago

Hm weird. This time, duplicating this, it works.. On Apr 21, 2015 10:14 AM, "Jesse van den Kieboom" notifications@github.com wrote:

As a test, I update the example/docs/index.md with your pasted index.md and example/docs/transport.md with your ctl.md. Run the doc generation, this works. The merged in markdown shows up as expected. Does any merged doc show up in the generated xml/index.xml ?

— Reply to this email directly or view it on GitHub https://github.com/jessevdk/cldoc/issues/97#issuecomment-94876731.