https://github.com/auscompgeek/sphinxify

Convert Javadoc/Doxygen to Sphinx reST docstrings :page_facing_up:
https://github.com/auscompgeek/sphinxify

converter javadoc python restructuredtext robotpy sphinx

Last synced: about 1 year ago
JSON representation

Convert Javadoc/Doxygen to Sphinx reST docstrings :page_facing_up:

• Host: GitHub
• URL: https://github.com/auscompgeek/sphinxify
• Owner: auscompgeek
• License: bsd-3-clause
• Created: 2018-05-05T02:43:47.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-04-28T19:05:15.000Z (about 1 year ago)
• Last Synced: 2025-04-28T20:23:16.651Z (about 1 year ago)
• Topics: converter, javadoc, python, restructuredtext, robotpy, sphinx
• Language: Python
• Homepage: https://pypi.org/project/sphinxify/
• Size: 70.3 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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][].

[RobotPy]: https://robotpy.github.io

[robotpy-ctre]: https://github.com/robotpy/robotpy-ctre