for instance you can document C++ or http APIs. It's pretty easy to write your own domains and I wrote an RDF domain that can used to represent just about anything that you can represent in RDF.
It's particularly good when you need to link multiple domains such as an API and its documentation in code, for instance you could document the event definitions in comments in your typescript code and have sphinx cut them out and make user docs for them.
It's an excellent answer to the problems of code and documentation although I have a few complaints such as they made an RST reader without making an RST writer, it uses global variables way too much, etc. But really I don't know anything that attacks the problems that is better.
http://www.sphinx-doc.org/en/master/index.html
which is sorta like "Javadoc" except you can make custom "domains", out of the box
http://www.sphinx-doc.org/en/master/usage/restructuredtext/d...
for instance you can document C++ or http APIs. It's pretty easy to write your own domains and I wrote an RDF domain that can used to represent just about anything that you can represent in RDF.
It's particularly good when you need to link multiple domains such as an API and its documentation in code, for instance you could document the event definitions in comments in your typescript code and have sphinx cut them out and make user docs for them.
It's an excellent answer to the problems of code and documentation although I have a few complaints such as they made an RST reader without making an RST writer, it uses global variables way too much, etc. But really I don't know anything that attacks the problems that is better.