Skip to main content

Convert Javadoc to Sphinx docstrings.

Project description


Convert Javadoc and Doxygen to Sphinx docstrings.


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...


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.

There is also a sphinxify yaml mode for the robotpy-ctre.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxify-0.9.tar.gz (8.7 kB view hashes)

Uploaded source

Built Distribution

sphinxify-0.9-py3-none-any.whl (5.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page