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.
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
Built Distribution
File details
Details for the file sphinxify-0.11.tar.gz.
File metadata
- Download URL: sphinxify-0.11.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 63abea6b2ede1a898b96365ceec5356e1f1248bedaf3e238d2a62f9bca44db0d |
|
| MD5 | 73c0fe53109f070ebe772886df24684e |
|
| BLAKE2b-256 | 35bcbe65c0933b15d205ce3b0ec93c4a5f5e7cb2c55969dc98b5a8f93364914b |
File details
Details for the file sphinxify-0.11-py3-none-any.whl.
File metadata
- Download URL: sphinxify-0.11-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8a7e1924f426519a7fc3c472304fa7f70dde4303a5a9700ea62aebf38042a5c3 |
|
| MD5 | 5b0de31f73526e03c9ad8d8b7b7eed30 |
|
| BLAKE2b-256 | b95caa1cc5e8ed3b2ebc00fc39d113f4bbf559b888533a7bf5f5501c13e58051 |
