Convert Javadoc to Sphinx docstrings.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for auscompgeek from gravatar.com auscompgeek

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Project description

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.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page