sphinx-java-autodoc 0.2.0__py3-none-any.whl

sphinx_java_autodoc/static/java-autodoc.css

@@ -0,0 +1,28 @@
+/* Sphinx's nowrap tokens can exceed the viewport for qualified Java signatures. */
+dl.java .pre {
+    white-space: normal;
+    overflow-wrap: anywhere;
+}
+
+/* Wide Javadoc tables scroll within the content column instead of the page. */
+.java-table-wrapper {
+    max-width: 100%;
+    overflow-x: auto;
+}
+
+/* Code in table cells stays whole; the table scrolls instead. */
+table.java-table code .pre {
+    white-space: pre;
+    overflow-wrap: normal;
+}
+
+/* Java summaries: names wrap between parameters, and anywhere on small screens. */
+table.java.autosummary .pre {
+    white-space: normal;
+}
+
+@media (max-width: 600px) {
+    table.java.autosummary td {
+        overflow-wrap: anywhere;
+    }
+}

sphinx_java_autodoc-0.2.0.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.5
+Name: sphinx-java-autodoc
+Version: 0.2.0
+Summary: Compiler-backed Java API documentation in native Sphinx nodes
+Project-URL: Documentation, https://r4sky0.github.io/sphinx-java-autodoc/
+Project-URL: Repository, https://github.com/r4sky0/sphinx-java-autodoc
+Project-URL: Issues, https://github.com/r4sky0/sphinx-java-autodoc/issues
+Project-URL: Changelog, https://github.com/r4sky0/sphinx-java-autodoc/releases
+Author: Ralph Offinger
+License-Expression: MIT
+License-File: LICENSE
+Keywords: autodoc,documentation,java,javadoc,sphinx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Java
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation :: Sphinx
+Requires-Python: >=3.12
+Requires-Dist: sphinx<9.2,>=9.1
+Provides-Extra: test
+Requires-Dist: build>=1; extra == 'test'
+Requires-Dist: playwright>=1.50; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# sphinx-java-autodoc
+
+[![CI](https://github.com/r4sky0/sphinx-java-autodoc/actions/workflows/ci.yml/badge.svg)](https://github.com/r4sky0/sphinx-java-autodoc/actions/workflows/ci.yml)
+[Documentation](https://r4sky0.github.io/sphinx-java-autodoc/)
+
+Publish your Java library's guides and API reference in one searchable Sphinx
+site. Keep API contracts in Java sources and Javadoc; write guides that help
+your users choose an API and complete a task.
+
+`sphinx-java-autodoc` reads Java sources and Javadoc comments with the JDK compiler
+APIs and renders them as native Sphinx content:
+
+- Generated, searchable pages for classes, interfaces, enums, records, annotation
+  types and nested types.
+- Signatures, overloads, Javadoc links and inherited method documentation.
+- Class excerpts in handwritten guides, and links between projects through intersphinx.
+- Pages that refresh when sources change, with content-based extraction caching.
+
+Extraction never executes application classes or annotation processors, and never
+downloads Java dependencies. See the [Apache Commons Lang example](https://r4sky0.github.io/sphinx-java-autodoc/showcase/commons-lang/furo/)
+for what the output looks like.
+
+## Requirements
+
+Python 3.12+, Sphinx 9.1.x, and **JDK 25 for extraction**. Your library can keep
+targeting Java 17 or 21. See [compatibility and limits](https://r4sky0.github.io/sphinx-java-autodoc/compatibility.html)
+for the tested versions.
+
+## Quick start
+
+```sh
+uv add "sphinx-java-autodoc @ git+https://github.com/r4sky0/sphinx-java-autodoc.git"
+```
+
+In `docs/conf.py`:
+
+```python
+extensions = ["sphinx_java_autodoc"]
+java_sources = ["../src/main/java"]
+java_release = "17"
+java_generate = "api"
+java_visibility = "public"
+```
+
+Add `api/index` to the toctree in `docs/index.rst`, then build:
+
+```sh
+uv run sphinx-build -W --keep-going -n docs docs/_build/html
+```
+
+[Publish your first API pages](https://r4sky0.github.io/sphinx-java-autodoc/getting-started.html) walks through these steps.
+Then continue with:
+
+- [Write a guide your users can follow](https://r4sky0.github.io/sphinx-java-autodoc/guide.html)
+- [Build with dependencies and CI](https://r4sky0.github.io/sphinx-java-autodoc/build-integration.html): Maven/Gradle
+  classpaths, pre-extracted models and publishing to GitHub Pages
+- [Configuration and reference](https://r4sky0.github.io/sphinx-java-autodoc/usage.html) and [supported Javadoc](https://r4sky0.github.io/sphinx-java-autodoc/javadoc-support.html)
+- [Troubleshooting](https://r4sky0.github.io/sphinx-java-autodoc/troubleshooting.html)
+- [How it works](https://r4sky0.github.io/sphinx-java-autodoc/design.html) and the [architecture decision](docs/adr/0001-jdk-doclet-xml-sphinx-domain.md)
+
+## Development
+
+From a clone of this repository:
+
+```sh
+uv sync --locked
+uv run --locked pre-commit install
+uv run --locked pre-commit run --all-files
+uv run --locked pytest
+uv run --locked --group showcase python showcase/build.py
+uv run --locked sphinx-build -W --keep-going -n docs docs/_build/html
+```
+
+Development and releases are documented in [CONTRIBUTING.md](CONTRIBUTING.md).
+CI covers lint, compiler warnings, integration tests, built distributions,
+dependency vulnerabilities, six HTML themes, the text builder, and Chromium
+browser interactions.
+
+[MIT licensed](LICENSE).

sphinx_java_autodoc-0.2.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+sphinx_java_autodoc/__init__.py,sha256=pWLjl0U0-OUDs_qgEEX_pv1Aq76aIcArov8hcuQcvsI,9208
+sphinx_java_autodoc/__main__.py,sha256=ZoDNKnyOSMsiGv7k6hfZgCEazLyvfiOpd096IFuBAEY,2240
+sphinx_java_autodoc/domain.py,sha256=TkpzmvfsgEXoQSaUVaSQ8fx59oSi5Thn-X1Egwdwt5A,14205
+sphinx_java_autodoc/extractor.py,sha256=sBBzCSukDeFGqeEUGMGblNnVp8kTMgKnaYCR2Gv_-5o,8847
+sphinx_java_autodoc/javadoc.py,sha256=p6EDQ-2_tt8YwI4UpM1hyKTF-9WDI79Gl-ukT4DCB4s,1808
+sphinx_java_autodoc/model.py,sha256=DvJEi4Q6C1wcpOo-3ym0l8PaKxPncEL3FXJuWzQZslY,7435
+sphinx_java_autodoc/render.py,sha256=Qduoo4nLpdAKKxFvDiifIKekbn70Jhh4_c-cPsL31wo,19112
+sphinx_java_autodoc/java/SphinxDoclet.java,sha256=zMDMq8Spiia6pcGjGa4TGaGr8FCcd7Pl3bKfu7OF8x8,37990
+sphinx_java_autodoc/static/java-autodoc.css,sha256=ahbn-sRIqh4RQBEJJ0tMmoHtF0RmRO_b8nfJNc1vJl4,694
+sphinx_java_autodoc-0.2.0.dist-info/METADATA,sha256=rFQk3YErqiazmwI-tggotDQWS2RR6S9R3Ch14-GPjC8,4576
+sphinx_java_autodoc-0.2.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+sphinx_java_autodoc-0.2.0.dist-info/entry_points.txt,sha256=WgWf-WcpfeRFC2tcLu7lY0_OF8s_YnB1x-_T4TijaWs,74
+sphinx_java_autodoc-0.2.0.dist-info/licenses/LICENSE,sha256=FE03yeUGD0GeRnHdafTfDp6JJzwDFOYi3xZJHcOQ8zo,1089
+sphinx_java_autodoc-0.2.0.dist-info/RECORD,,

sphinx_java_autodoc-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

sphinx_java_autodoc-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sphinx-java-autodoc = sphinx_java_autodoc.__main__:main

sphinx_java_autodoc-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sphinx-java-autodoc contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.