Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Convert Javadoc to Sphinx docstrings.

Project description

sphinxify

Convert Javadoc (and Doxygen, maybe) 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.

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxify-0.2-py3-none-any.whl (9.0 kB) Copy SHA256 hash SHA256 Wheel py3 May 5, 2018
sphinxify-0.2.tar.gz (4.7 kB) Copy SHA256 hash SHA256 Source None May 5, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page