Jython 3 snapshot on APIdia
Stefan Richthofer <[email protected]> Fri, 5 Apr 2024 02:12:25 +0200
| Newsgroups | gmane.comp.lang.jython.devel |
|---|---|
| Message-ID | <CACQYzF+TivdkWRbf6N-bsyZ=py=QNEb1ZBH14MN70ZJ5HVfdgg@mail.gmail.com> |
--===============2882476770212346326== Content-Type: multipart/alternative; boundary="000000000000a4bb5f06154e516a" --000000000000a4bb5f06154e516a Content-Type: text/plain; charset="UTF-8" Dear Folks, most of you probably got the APIdia announcement already via jython-user (for those who didn't, it is appended below). Since this is the dev list, I would like to point out that also a snapshot of the Jython 3 core ( github.com/jython/jython/tree/main) is available on APIdia at https://apidia.net/java/Jython/3.0.0-snapshot Jython 3 is pre-alpha and experimental, so it is not accessible by the search on the landing page apidia.net -- just directly via the given link. --- original announcement to jython-users --- 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 --000000000000a4bb5f06154e516a Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable <div dir=3D"ltr">Dear Folks,<br><br>most of you probably got the APIdia ann= ouncement already via jython-user (for those who didn't, it is appended= below). Since this is the dev list, I would like to point out that also a = snapshot of the Jython 3 core (<a href=3D"http://github.com/jython/jython/t= ree/main">github.com/jython/jython/tree/main</a>) is available on APIdia at= <br><br><a href=3D"https://apidia.net/java/Jython/3.0.0-snapshot">https://a= pidia.net/java/Jython/3.0.0-snapshot</a><br><br><div>Jython 3 is pre-alpha = and experimental, so it is not accessible by the search on the landing page= <a href=3D"http://apidia.net">apidia.net</a> -- just directly via the give= n link.</div><div><br></div><div><br></div><div>--- original announcement t= o jython-users ---</div><div><br></div><div>Dear Jythonistas, Jython and Ja= va enthusiasts,<br><br>with this email I proudly announce that a new Java A= PI 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/ja= va/Jython">apidia.net/java/Jython</a><br><br>The documentation resembles Ja= vadoc but with some improvements.<br><br>Perhaps most notably, it revives t= he 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 imple= mented in a future-proof way.)<br>The search field was intended as a replac= ement, but I always felt that a structured API navigation and a search fiel= d are really two things. To address that, on APIdia you have both.<br><br>S= imilar to Javadoc, the search field searches names of classes/interfaces et= c., members, packages and modules. On APIdia, it also features regex functi= onality (e.g. "|", "^", "$" work as "or&= quot;, "start" and "end", respectively) with following = special rules: spaces are interpreted as ".*", which means you ca= n type space-separated snippets of a long name to quickly specify your targ= et. If the search text contains a ".", fully qualified names are = searched.<br><br>While you navigate through docs, the site maintains a para= meterized url that can serve as a link to the current view state.<br><br>As= of this writing, APIdia hosts the full Java 22 standard library and severa= l hundred artifacts from Maven Central. In addition to Jython, that include= s Guava, all other Jython dependencies, Netty, Jetty, JavaFX, Jakarta and J= ava EE artifacts, most of Apache commons and Spring to some extent. All hos= ted projects are fully interlinked.<br><br>Various design details are impro= ved 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.", &qu= ot;i.e." and so on. Common patterns such as "Note: ...", &qu= ot;Warning: ...", "Issue: ..." etc. are rendered as proper a= dmonition 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.<br><br>In the top-right= menu, you can edit visibility settings and turn on private methods, intern= al packages and modules. If you check and uncheck the boxes, the site adjus= ts the displayed content accordingly. So, if you want to hack on Jython int= ernals, this is the place for you.<br><br>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.<br><br>What's more to say? API= dia 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 feedbac= k, so it can improve.<br><br>Happy API documentation browsing!</div><div><b= r></div><div>Stefan<br></div></div> --000000000000a4bb5f06154e516a-- --===============2882476770212346326== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline --===============2882476770212346326== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Jython-dev mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/jython-dev --===============2882476770212346326==--