sphinx2doxygen
is a simple documentation string parser. It's aim is to rewrite Sphinx style documentation strings to Google style documentation strings that are compatible with Doxygen.
Installation
pip install pep2google
Usage
sphinx2doxygen [-h] [-f] -i DIR -o DIR [-e expr]
Rewrites python docstring code commenting from PEP to Google style.
optional arguments:
-h, --help show this help message and exit
-f, --force do not ask before overwriting files
-i DIR, --input-dir DIR
source code directory
-o DIR, --output-dir DIR
directory for the rewritten files
-e expr, --expression expr
only process files that match the given expression (default: *.py)
Bugs
Please open a ticket in the issue tracker.
1 maintainer
Metadata
1 maintainer
Release files for sphinx2doxygen 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinx2doxygen-0.1.tar.gz | 3.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx2doxygen-0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.6 kB
Release files / sphinx2doxygen-0.1.tar.gz
| Download URL | sphinx2doxygen-0.1.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c104e7848495ae2dc8b9a842dfe63f742cf76666e4d67f4e0c97d03be5127cab
|
|
BLAKE2b-256 checksum How to use checksums |
f6019017b6ddb322250248be119c053ead76c63d7ba80700b73959edc6cdfcfd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Release files / sphinx2doxygen-0.1-py3-none-any.whl
| Download URL | sphinx2doxygen-0.1-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9386b473294c2dbbcd6526e71f9fc08eb5668dc45ededf32837f56feae11619f
|
|
BLAKE2b-256 checksum How to use checksums |
f1e6ad60e9ed26c122285d0a0012e1e748f9c627bb7c82f662cc1f798251da10
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Security for sphinx2doxygen 0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
