Convert Javadoc to Sphinx docstrings.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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.
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.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinxify-0.12.tar.gz.
File metadata
- Download URL: sphinxify-0.12.tar.gz
- Upload date:
- Size: 6.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ec299e78babac7d3457f47bf263411b48e10b9c8add18d7159fa0327cc4a061
|
|
| MD5 |
76e472a5241f0676d9aaa5c72fbc041e
|
|
| BLAKE2b-256 |
9bc6b14634891cdd286e7bf949673d67e2452b5f1e8ade58fe6b06842d8b816e
|
Provenance
The following attestation bundles were made for sphinxify-0.12.tar.gz:
Publisher:
pythonpackage.yml on auscompgeek/sphinxify
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxify-0.12.tar.gz -
Subject digest:
3ec299e78babac7d3457f47bf263411b48e10b9c8add18d7159fa0327cc4a061 - Sigstore transparency entry: 173454559
- Sigstore integration time:
-
Permalink:
auscompgeek/sphinxify@f3bb72b4afd65e823841e44586e70befdfaa9f44 -
Branch / Tag:
refs/tags/0.12 - Owner: https://github.com/auscompgeek
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pythonpackage.yml@f3bb72b4afd65e823841e44586e70befdfaa9f44 -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinxify-0.12-py3-none-any.whl.
File metadata
- Download URL: sphinxify-0.12-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ec97af947884bacd8e18f14ff2b6030b6da829a6a5bf7a32421b633b10c6f7e8
|
|
| MD5 |
dd173128536e3f17ccb765d17f6d367a
|
|
| BLAKE2b-256 |
413592fe84f7271c36d8fbc19e592a963214bc54e4cb365633378cf5463a9b85
|
Provenance
The following attestation bundles were made for sphinxify-0.12-py3-none-any.whl:
Publisher:
pythonpackage.yml on auscompgeek/sphinxify
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinxify-0.12-py3-none-any.whl -
Subject digest:
ec97af947884bacd8e18f14ff2b6030b6da829a6a5bf7a32421b633b10c6f7e8 - Sigstore transparency entry: 173454560
- Sigstore integration time:
-
Permalink:
auscompgeek/sphinxify@f3bb72b4afd65e823841e44586e70befdfaa9f44 -
Branch / Tag:
refs/tags/0.12 - Owner: https://github.com/auscompgeek
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pythonpackage.yml@f3bb72b4afd65e823841e44586e70befdfaa9f44 -
Trigger Event:
push
-
Statement type:
