Skip to main content

sphinxify

Convert Javadoc and Doxygen to Sphinx reStructuredText 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.

To run the tests, install tests/requirements.txt, then run python -m pytest from the repository root.

Metadata

Release files for sphinxify 0.13.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxify 0.13.1
File Size Uploaded Provenance Actions
sphinxify-0.13.1.tar.gz 6.6 kB With provenance Details for sphinxify-0.13.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinxify 0.13.1
File Interpreter ABI Platform Actions
sphinxify-0.13.1-py3-none-any.whl Python 3 none any Details for sphinxify-0.13.1-py3-none-any.whl

Total release size: 15.0 kB

Release files / sphinxify-0.13.1.tar.gz

Download URL sphinxify-0.13.1.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
6216e2a664dba3655e1e1e002240c998caedd2359375866b3bd1f53ef17305cb
BLAKE2b-256 checksum
How to use checksums
279f6fedf27c6de91f43a7fd7e9d992ea46c40661d1e3533e9a0a554d1c0a8f7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 22, 2026.

Transparency log

Release files / sphinxify-0.13.1-py3-none-any.whl

Download URL sphinxify-0.13.1-py3-none-any.whl
Size 8.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5231158ad04dec4edf1824d2757da90ae6ce2b25655ebdda699192d372aea617
BLAKE2b-256 checksum
How to use checksums
98fdb8c3ad1ec3cf767ea5ac016195497f6264e8570454849ed44cd69ed716cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 Oct 22, 2026.

Transparency log

Security for sphinxify 0.13.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for sphinxify-0.13.1.tar.gz

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 Oct 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page