Ask HN: Which tool for generating aesthetically pleasing C++ reference docs?

Posted by starbugs on Thursday September 13, 2018 @03:51AM
from the ask-hn dept.

Doxygen output is not exactly beautiful or state of the art. Tools that take doxygen XMLs and convert them to something visually pleasing and usable seem to be a mixed bag.

Are there any great projects you'd recommend?

( 9 comments | 8 points | on HN )

Re:Ask HN: Which tool for generating aesthetically pleasing ... by billconan on Thursday September 13, 2018 @10:35AM (#17978913)

I'm making https://doctory.io , but it's half baked.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by billconan on Thursday September 13, 2018 @10:36AM (#17978928)

don't use it, cause it is under development.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by starbugs on Tuesday September 25, 2018 @03:20AM (#18064249)

I've looked into your tool. To be honest, I don't really get it. How do I get started about creating a documentation?

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by stackmad on Friday September 28, 2018 @03:57AM (#18091694)

I'd recommend having a look at sphinx together with exhale https://exhale.readthedocs.io/en/latest/

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by billconan on Thursday September 13, 2018 @10:39AM (#17978942)

I do like some feedbacks if you want to try it.

you need to add a config file (json) under your project's root directory, like this one:

https://github.com/shi-yan/Swiftly/blob/master/doctory.conf

to specify the folder of your project that contains the doxygen config file.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by starbugs on Thursday September 13, 2018 @10:48AM (#17979018)

Looking for a mature tool, but thanks for posting. I'll give it a try and let you know what we think.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by billconan on Thursday September 13, 2018 @11:01AM (#17979127)

since I'm making a solution, I did do some research. if you are looking for a hosted solution, https://breathe.readthedocs.io/en/latest/readthedocs.html

readthedocs + breathe might be the best right now.

I have seen someone making really good looking doxygen skins, like this

http://doc.magnum.graphics/magnum/namespaceMagnum_1_1GL.html...

but I don't know if it is opensource.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by billconan on Thursday September 13, 2018 @11:07AM (#17979193)

I really didn't find too many options. That's why I want to build doctory.io. let me know if you find more.

[ Parent | on HN ]

Re:Ask HN: Which tool for generating aesthetically pleasing ... by IloveHN84 on Thursday September 13, 2018 @11:38AM (#17979463)

Asciidoc

[ Parent | on HN ]