Jython on APIdia
Stefan Richthofer <[email protected]> Fri, 5 Apr 2024 02:08:14 +0200
| Newsgroups | gmane.comp.lang.jython.user |
|---|---|
| Message-ID | <CACQYzF+umokGzpaGxCBGAuwxknkJk20uMRv10UZ1rZ_d62Wsrg@mail.gmail.com> |
--===============5770750623029776398== Content-Type: multipart/alternative; boundary="000000000000ba925e06154e42c2" --000000000000ba925e06154e42c2 Content-Type: text/plain; charset="UTF-8" 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 --000000000000ba925e06154e42c2 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr">Dear Jythonistas, Jython and Java enthusiasts,<br><br>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<br><br><a href=3D"http://apidia.net/java/Jython">apidia.net/java/= Jython</a><br><br>The documentation resembles Javadoc but with some improve= ments.<br><br>Perhaps most notably, it revives the package and class side n= avigation, 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 wa= y.)<br>The search field was intended as a replacement, but I always felt th= at a structured API navigation and a search field are really two things. To= address that, on APIdia you have both.<br><br>Similar to Javadoc, the sear= ch field searches names of classes/interfaces etc., members, packages and m= odules. On APIdia, it also features regex functionality (e.g. "|"= , "^", "$" work as "or", "start" an= d "end", respectively) with following special rules: spaces are i= nterpreted as ".*", which means you can type space-separated snip= pets of a long name to quickly specify your target. If the search text cont= ains a ".", fully qualified names are searched.<br><br>While you = navigate through docs, the site maintains a parameterized url that can serv= e as a link to the current view state.<br><br>As of this writing, APIdia ho= sts the full Java 22 standard library and several hundred artifacts from Ma= ven Central. In addition to Jython, that includes Guava, all other Jython d= ependencies, Netty, Jetty, JavaFX, Jakarta and Java EE artifacts, most of A= pache commons and Spring to some extent. All hosted projects are fully inte= rlinked.<br><br>Various design details are improved over Javadoc. To name s= ome, 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. Co= mmon patterns such as "Note: ...", "Warning: ...", &quo= t;Issue: ..." etc. are rendered as proper admonition boxes. Functions = transparently indicate if some other function is overridden, implemented, h= idden or redeclared, whether and where from doc is inherited, and whether d= eprecation is inherited.<br><br>In the top-right menu, you can edit visibil= ity settings and turn on private methods, internal packages and modules. If= you check and uncheck the boxes, the site adjusts the displayed content ac= cordingly. So, if you want to hack on Jython internals, this is the place f= or you.<br><br>With this functionality, the site is still lightweight and f= ast. Since it is free of tracking, you won't be bothered by annoying co= okie banners.<br><br>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 wor= d to your fellow devs and kindly provide feedback, so it can improve.<br><b= r><div>Happy API documentation browsing!</div><div><br></div><div>Stefan</d= iv><div><br></div></div> --000000000000ba925e06154e42c2-- --===============5770750623029776398== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline --===============5770750623029776398== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Jython-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/jython-users --===============5770750623029776398==--