sphinx-java-autodoc 0.2.0__tar.gz → 0.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/PKG-INFO +3 -2
  2. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/README.md +2 -1
  3. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/build-integration.rst +1 -1
  4. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/getting-started.rst +2 -4
  5. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/pyproject.toml +1 -1
  6. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/extractor.py +1 -1
  7. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/.gitignore +0 -0
  8. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/CONTRIBUTING.md +0 -0
  9. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/LICENSE +0 -0
  10. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/SECURITY.md +0 -0
  11. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/adr/0001-jdk-doclet-xml-sphinx-domain.md +0 -0
  12. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/agents/domain.md +0 -0
  13. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/agents/issue-tracker.md +0 -0
  14. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/alternatives.rst +0 -0
  15. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/compatibility.rst +0 -0
  16. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/conf.py +0 -0
  17. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/design.rst +0 -0
  18. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/guide.rst +0 -0
  19. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/index.rst +0 -0
  20. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/javadoc-support.rst +0 -0
  21. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/performance.rst +0 -0
  22. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/roadmap.md +0 -0
  23. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/schema.md +0 -0
  24. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/showcase.rst +0 -0
  25. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/troubleshooting.rst +0 -0
  26. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/usage.rst +0 -0
  27. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/README.md +0 -0
  28. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/build-consumer/BuildInfo.java.in +0 -0
  29. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/build-consumer/src/demo/Consumer.java +0 -0
  30. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/dependency/src/vendor/Token.java +0 -0
  31. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/gradle/build.gradle +0 -0
  32. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/gradle/settings.gradle +0 -0
  33. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/maven/pom.xml +0 -0
  34. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/docs/conf.py +0 -0
  35. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/docs/guide.rst +0 -0
  36. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/docs/index.rst +0 -0
  37. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/docs/reference.rst +0 -0
  38. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/Label.java +0 -0
  39. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/Mode.java +0 -0
  40. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/Point.java +0 -0
  41. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/Transformer.java +0 -0
  42. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/Widget.java +0 -0
  43. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/examples/standalone/src/demo/package-info.java +0 -0
  44. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/__init__.py +0 -0
  45. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/__main__.py +0 -0
  46. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/domain.py +0 -0
  47. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/java/SphinxDoclet.java +0 -0
  48. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/javadoc.py +0 -0
  49. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/model.py +0 -0
  50. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/render.py +0 -0
  51. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/static/java-autodoc.css +0 -0
  52. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/benchmark.py +0 -0
  53. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/build_tools_check.py +0 -0
  54. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_boundaries.py +0 -0
  55. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_conformance.py +0 -0
  56. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_generic_throws.py +0 -0
  57. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_integration.py +0 -0
  58. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_javadoc.py +0 -0
  59. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_navigation.py +0 -0
  60. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_signatures.py +0 -0
  61. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_snippets.py +0 -0
  62. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_sourcepath.py +0 -0
  63. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_tables.py +0 -0
  64. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/test_value.py +0 -0
  65. {sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/tests/visual_check.py +0 -0
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: sphinx-java-autodoc
3
- Version: 0.2.0
3
+ Version: 0.2.1
4
4
  Summary: Compiler-backed Java API documentation in native Sphinx nodes
5
5
  Project-URL: Documentation, https://r4sky0.github.io/sphinx-java-autodoc/
6
6
  Project-URL: Repository, https://github.com/r4sky0/sphinx-java-autodoc
@@ -31,6 +31,7 @@ Description-Content-Type: text/markdown
31
31
  # sphinx-java-autodoc
32
32
 
33
33
  [![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)
34
+ [![PyPI](https://img.shields.io/pypi/v/sphinx-java-autodoc)](https://pypi.org/project/sphinx-java-autodoc/)
34
35
  [Documentation](https://r4sky0.github.io/sphinx-java-autodoc/)
35
36
 
36
37
  Publish your Java library's guides and API reference in one searchable Sphinx
@@ -59,7 +60,7 @@ for the tested versions.
59
60
  ## Quick start
60
61
 
61
62
  ```sh
62
- uv add "sphinx-java-autodoc @ git+https://github.com/r4sky0/sphinx-java-autodoc.git"
63
+ uv add sphinx-java-autodoc
63
64
  ```
64
65
 
65
66
  In `docs/conf.py`:
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/README.md RENAMED
@@ -1,6 +1,7 @@
1
1
  # sphinx-java-autodoc
2
2
 
3
3
  [![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)
4
+ [![PyPI](https://img.shields.io/pypi/v/sphinx-java-autodoc)](https://pypi.org/project/sphinx-java-autodoc/)
4
5
  [Documentation](https://r4sky0.github.io/sphinx-java-autodoc/)
5
6
 
6
7
  Publish your Java library's guides and API reference in one searchable Sphinx
@@ -29,7 +30,7 @@ for the tested versions.
29
30
  ## Quick start
30
31
 
31
32
  ```sh
32
- uv add "sphinx-java-autodoc @ git+https://github.com/r4sky0/sphinx-java-autodoc.git"
33
+ uv add sphinx-java-autodoc
33
34
  ```
34
35
 
35
36
  In `docs/conf.py`:
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/build-integration.rst RENAMED
@@ -170,7 +170,7 @@ deploys to GitHub Pages. In the repository settings, set **Pages → Source** to
170
170
  - uses: actions/setup-python@v7
171
171
  with:
172
172
  python-version: "3.12"
173
- - run: python -m pip install "git+https://github.com/r4sky0/sphinx-java-autodoc.git"
173
+ - run: python -m pip install sphinx-java-autodoc
174
174
  # Prepare java_classpath inputs and generated sources here, for example
175
175
  # with the Maven or Gradle commands below.
176
176
  - run: sphinx-build -W --keep-going -n docs docs/_build/html
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/docs/getting-started.rst RENAMED
@@ -32,15 +32,13 @@ From an existing uv project:
32
32
 
33
33
  .. code-block:: console
34
34
 
35
- uv add "sphinx-java-autodoc @ git+https://github.com/r4sky0/sphinx-java-autodoc.git"
35
+ uv add sphinx-java-autodoc
36
36
 
37
37
  Or install into an existing Python virtual environment:
38
38
 
39
39
  .. code-block:: console
40
40
 
41
- python -m pip install "git+https://github.com/r4sky0/sphinx-java-autodoc.git"
42
-
43
- The extension has not been published to PyPI yet, so install it from GitHub.
41
+ python -m pip install sphinx-java-autodoc
44
42
 
45
43
  Point Sphinx at your sources
46
44
  ----------------------------
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/pyproject.toml RENAMED
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
4
4
 
5
5
  [project]
6
6
  name = "sphinx-java-autodoc"
7
- version = "0.2.0"
7
+ version = "0.2.1"
8
8
  description = "Compiler-backed Java API documentation in native Sphinx nodes"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.12"
{sphinx_java_autodoc-0.2.0 → sphinx_java_autodoc-0.2.1}/src/sphinx_java_autodoc/extractor.py RENAMED
@@ -15,7 +15,7 @@ from sphinx.errors import ExtensionError
15
15
 
16
16
  from .model import read_model
17
17
 
18
- VERSION = "0.2.0" # x-release-please-version
18
+ VERSION = "0.2.1" # x-release-please-version
19
19
  DOCLET = Path(__file__).parent / "java" / "SphinxDoclet.java"
20
20
 
21
21