Integrate JavaDoc

13 views

Skip to first unread message

unread,

May 14, 2023, 9:44:52 AM5/14/23

to sphinx-users

Greetings.

For everyone interested in publishing JavaDoc with a Sphinx generated WebSite, I have picked up XMLDoclet and amended it. Please see https://github.com/manticore-projects/xml-doclet

1) it works with any modern JDK 11, 17, 21

2) translates into a Restructured Text document which can be used with Sphinx

3) supports Groovy and Maven, Artifact is com.manticore-projects.tools:xml-doclet:1.2.1

4) all kind of linking and referencing works

I plan to support Markdown, Docbook and Ascii Doctor too and would like to welcome any volunteers and/or testers.

Also the mangling of the descriptions can be certainly improved.

Looking forward hearing from you,

Andreas

unread,

May 21, 2023, 10:59:21 AM5/21/23

to sphinx-users

Greetings!

We have improved the Rendering of the JavaDoc and added a "Floating TOC", which helps to keep the orientation.

Website: https://www.manticore-projects.com/XMLDoclet/index.html

Example: https://www.manticore-projects.com/JSQLParser/javadoc_snapshot.html#binaryexpression

Looking forward hearing from you,

Andreas

Reply all

Reply to author

Forward

0 new messages