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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx2doxygen-0.1.tar.gz
(3.6 kB
view details)
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 sphinx2doxygen-0.1.tar.gz.
File metadata
- Download URL: sphinx2doxygen-0.1.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c104e7848495ae2dc8b9a842dfe63f742cf76666e4d67f4e0c97d03be5127cab
|
|
| MD5 |
2e12d1c2ab44d4f5a0b08e00372224c2
|
|
| BLAKE2b-256 |
f6019017b6ddb322250248be119c053ead76c63d7ba80700b73959edc6cdfcfd
|
File details
Details for the file sphinx2doxygen-0.1-py3-none-any.whl.
File metadata
- Download URL: sphinx2doxygen-0.1-py3-none-any.whl
- Upload date:
- Size: 9.1 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9386b473294c2dbbcd6526e71f9fc08eb5668dc45ededf32837f56feae11619f
|
|
| MD5 |
0e9eb299742ec636bc7eba927d284e24
|
|
| BLAKE2b-256 |
f1e6ad60e9ed26c122285d0a0012e1e748f9c627bb7c82f662cc1f798251da10
|
