sphinxify
Convert Javadoc and Doxygen to Sphinx docstrings.
Why?
The RobotPy project ports Java libraries to Python.
A converter was originally written in HTML + JavaScript, but then the need to be able to programmatically convert doc comments arose.
This also makes it easier to use in certain editors such as vim...
Usage
Run sphinxify and give it a Javadoc comment. It will keep reading until EOF.
If a Java function prototype is also given, sphinxify will also output a Python type-hinted function signature.
You can also run sphinxify server and it will pop up a browser that you can
use to run sphinxify on the input also.
There is also a sphinxify yaml mode for the robotpy-ctre.
1 maintainer
Metadata
1 maintainer
Release files for sphinxify 0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxify-0.12.tar.gz | 6.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxify-0.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 13.3 kB
Release files / sphinxify-0.12.tar.gz
| Download URL | sphinxify-0.12.tar.gz |
|---|---|
| Size | 6.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3ec299e78babac7d3457f47bf263411b48e10b9c8add18d7159fa0327cc4a061
|
|
BLAKE2b-256 checksum How to use checksums |
9bc6b14634891cdd286e7bf949673d67e2452b5f1e8ade58fe6b06842d8b816e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 22, 2025.
Transparency logRelease files / sphinxify-0.12-py3-none-any.whl
| Download URL | sphinxify-0.12-py3-none-any.whl |
|---|---|
| Size | 7.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ec97af947884bacd8e18f14ff2b6030b6da829a6a5bf7a32421b633b10c6f7e8
|
|
BLAKE2b-256 checksum How to use checksums |
413592fe84f7271c36d8fbc19e592a963214bc54e4cb365633378cf5463a9b85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Feb 22, 2025.
Transparency log
