Skip to main content

Rewrites python documentation string code commenting from Sphinx to Doxygen format.

Project description

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.

Project details


Release history Release notifications | RSS feed

This version

0.1

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 hashes)

Uploaded source

Built Distribution

sphinx2doxygen-0.1-py3-none-any.whl (9.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page