| Name | sphinxify JSON |
| Version |
0.11
JSON |
| download |
| home_page | |
| Summary | Convert Javadoc to Sphinx docstrings. |
| upload_time | 2024-01-05 03:49:41 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| keywords |
javadoc
sphinx
doxygen
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinxify",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "javadoc,sphinx,doxygen",
"author": "",
"author_email": "David Vo <david@vovo.id.au>",
"download_url": "https://files.pythonhosted.org/packages/35/bc/be65c0933b15d205ce3b0ec93c4a5f5e7cb2c55969dc98b5a8f93364914b/sphinxify-0.11.tar.gz",
"platform": null,
"description": "# sphinxify\nConvert Javadoc and Doxygen to Sphinx docstrings.\n\n## Why?\nThe [RobotPy][] project ports Java libraries to Python.\n\nA converter was originally written in HTML + JavaScript, but then the need to\nbe able to programmatically convert doc comments arose.\n\nThis also makes it easier to use in certain editors such as vim...\n\n## Usage\nRun `sphinxify` and give it a Javadoc comment. It will keep reading until EOF.\n\nIf a Java function prototype is also given, sphinxify will also output a\nPython type-hinted function signature.\n\nThere is also a `sphinxify yaml` mode for the [robotpy-ctre][].\n\n[RobotPy]: https://robotpy.github.io\n[robotpy-ctre]: https://github.com/robotpy/robotpy-ctre\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Convert Javadoc to Sphinx docstrings.",
"version": "0.11",
"project_urls": {
"Source": "https://github.com/auscompgeek/sphinxify"
},
"split_keywords": [
"javadoc",
"sphinx",
"doxygen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b95caa1cc5e8ed3b2ebc00fc39d113f4bbf559b888533a7bf5f5501c13e58051",
"md5": "5b0de31f73526e03c9ad8d8b7b7eed30",
"sha256": "8a7e1924f426519a7fc3c472304fa7f70dde4303a5a9700ea62aebf38042a5c3"
},
"downloads": -1,
"filename": "sphinxify-0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b0de31f73526e03c9ad8d8b7b7eed30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6094,
"upload_time": "2024-01-05T03:49:40",
"upload_time_iso_8601": "2024-01-05T03:49:40.277731Z",
"url": "https://files.pythonhosted.org/packages/b9/5c/aa1cc5e8ed3b2ebc00fc39d113f4bbf559b888533a7bf5f5501c13e58051/sphinxify-0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35bcbe65c0933b15d205ce3b0ec93c4a5f5e7cb2c55969dc98b5a8f93364914b",
"md5": "73c0fe53109f070ebe772886df24684e",
"sha256": "63abea6b2ede1a898b96365ceec5356e1f1248bedaf3e238d2a62f9bca44db0d"
},
"downloads": -1,
"filename": "sphinxify-0.11.tar.gz",
"has_sig": false,
"md5_digest": "73c0fe53109f070ebe772886df24684e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5451,
"upload_time": "2024-01-05T03:49:41",
"upload_time_iso_8601": "2024-01-05T03:49:41.882877Z",
"url": "https://files.pythonhosted.org/packages/35/bc/be65c0933b15d205ce3b0ec93c4a5f5e7cb2c55969dc98b5a8f93364914b/sphinxify-0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-05 03:49:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "auscompgeek",
"github_project": "sphinxify",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinxify"
}
