Before I formally RFC aspects of the new doc platform, I wanted to be sure I understood how each team in DM was documenting their source code and APIs so I could be sure I accommodated everyone.
Known languages:
- C++. Uses doxygen that can be handled with breathe.
- Python. Uses doxygen or ‘native’ docstring formats that breath/numpydoc/sphinx can handle.
Comments requested for:
- JavaScript. How are you commenting your JS code? Would jsdoc syntax work? I think I can get that into Sphinx using https://github.com/debrouwere/jsdoc-for-sphinx
- Java. Are you using Javadoc or doxygen for Java code?
- REST. Is there a formal documentation system already in place for REST APIs? Would you be ok with the httpdomain sphinx extension?
Are there any other languages we might want to generate API references for?