Metadata-Version: 2.1
Name: sphinxify
Version: 0.8.1
Summary: Convert Javadoc to Sphinx docstrings.
Home-page: https://github.com/auscompgeek/sphinxify
License: BSD-3-Clause
Keywords: javadoc sphinx doxygen
Author: David Vo
Author-email: david@vovo.id.au
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: dataclasses; python_version < '3.7'

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

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

