[Jython-users] Jython on APIdia

[Stefan R. <ste...@gm...>]

Dear Jythonistas, Jython and Java enthusiasts,

with this email I proudly announce that a new Java API documentation
website is in town and Jython is among the first projects being hosted.
Please check it out at

apidia.net/java/Jython

The documentation resembles Javadoc but with some improvements.

Perhaps most notably, it revives the package and class side navigation,
which Javadoc used to have until Java 12. (That was removed due to
deprecation of frames. On APIdia, it is implemented in a future-proof way.)
The search field was intended as a replacement, but I always felt that a
structured API navigation and a search field are really two things. To
address that, on APIdia you have both.

Similar to Javadoc, the search field searches names of classes/interfaces
etc., members, packages and modules. On APIdia, it also features regex
functionality (e.g. "|", "^", "$" work as "or", "start" and "end",
respectively) with following special rules: spaces are interpreted as ".*",
which means you can type space-separated snippets of a long name to quickly
specify your target. If the search text contains a ".", fully qualified
names are searched.

While you navigate through docs, the site maintains a parameterized url
that can serve as a link to the current view state.

As of this writing, APIdia hosts the full Java 22 standard library and
several hundred artifacts from Maven Central. In addition to Jython, that
includes Guava, all other Jython dependencies, Netty, Jetty, JavaFX,
Jakarta and Java EE artifacts, most of Apache commons and Spring to some
extent. All hosted projects are fully interlinked.

Various design details are improved over Javadoc. To name some, function
args have mouseover tooltip texts (if corresponding docs are available).
Summary lines are robust: sentences do not end prematurely with common
abbreviations like "e.g.", "i.e." and so on. Common patterns such as "Note:
...", "Warning: ...", "Issue: ..." etc. are rendered as proper admonition
boxes. Functions transparently indicate if some other function is
overridden, implemented, hidden or redeclared, whether and where from doc
is inherited, and whether deprecation is inherited.

In the top-right menu, you can edit visibility settings and turn on private
methods, internal packages and modules. If you check and uncheck the boxes,
the site adjusts the displayed content accordingly. So, if you want to hack
on Jython internals, this is the place for you.

With this functionality, the site is still lightweight and fast. Since it
is free of tracking, you won't be bothered by annoying cookie banners.

What's more to say? APIdia launched just days ago, so what it needs now is
users. If you like the site, please spread the word to your fellow devs and
kindly provide feedback, so it can improve.

Happy API documentation browsing!

Stefan