search

kohler / click

The Click modular router: fast modular packet processing and analysis
Other
740 stars 321 forks source link

How to build web docs? #324

Open scgruber opened 7 years ago

scgruber commented 7 years ago

I'm trying to generate documentation analogous to what is hosted at http://www.read.cs.ucla.edu/click/elements but including our own internal Click elements. It seems like doc/mkwebdoc.pl should do this, but the script appears to reference some templates that are not a part of this repository.

What is it that I need to be able to build the docs?

tbarbette commented 7 years ago

Did you found a solution? I'm interested into this also.

bcronje commented 6 years ago

Anyone found a solution to this yet? Seeing that the click website has been offline for a while now.

kohler commented 6 years ago

The UCLA server hosting the Click website died.

This is a workable snapshot: https://web.archive.org/web/20170630154754/read.cs.ucla.edu/click

kohler commented 6 years ago

The click-elem2man also accepts a --markdown flag that is intended to generate GitHub-flavored Markdown.

I would recommend not starting from doc/mkwebdoc.pl, but rather starting from that.

I've uploaded the Click elements to the wiki here.

bcronje commented 6 years ago

Thank you Eddie. The element docs in the wiki is great.

For the API documentation which I use quite often I'm assuming Doxygen would be the tool to generate that right? I'm sure there will be some doxygen to markdown tool somewhere, I will look into this when I get some time.

kohler commented 6 years ago

Yes, Doxygen is the relevant tool.

You can automatically run Doxygen from the doc/ directory:

$ cd CLICKBUILDDIR/doc
$ make doxygen O=OUTPUTDIRECTORY

I've also added this to generate all the Markdown manual documentation:

$ cd CLICKBUILDDIR/doc
$ make install-man-markdown O=OUTPUTDIRECTORY