Convert Javadoc to Sphinx docstrings.
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.
There is also a sphinxify yaml
mode for the robotpy-ctre.
Project details
Release history Release notifications | RSS feed
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.5.2.tar.gz
(5.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinxify-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c0dfeea3cccc845927550e2f1ccd4aadd0592e3e8de6a8b56cdefd3e39b675e |
|
MD5 | 6d7c61a1e3f210c83411e7de8ece113e |
|
BLAKE2b-256 | 5f550a7431ac17a85b9aa962847cef05dea0f0ca126bdc292d07a83c43734a87 |