Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Add processing of sphinx-like docstring specs to pdoc via preprocessor.

Project description

pdoc_prep: Add sphinx-like function doc specs to pdoc

Prepares Python files that use sphinx-like parameter and return specifications for input to the pdoc documentation tool (https://pypi.org/project/pdoc/).

Motivation:

The pdoc HTML output does not recognize function/method parameter and return specifications in doc strings as special. So,

   :param foo: controls whether bar is set to None
   :type foo: int
   :return True for success, else False
   :rtype bool

will show up literally. If a module to be documentated is instead preprocessed using this script, then the pdoc documentation will look like this:

          foo (int): controls whether bar is set to None
          returns True for success, else False
          return type: bool

The keywords, such as returns, and parameters, such as foo (int) will be bold faced.

Note: whether ':' is used to introduce a specification, or '@' is controlled from a command line option. See main section below.

Usage

shell> pdoc_run.py --html-dir docs src/pdoc_prep/pdoc_prep.py

This command may be run from the project root, from within the evolving docs directory, or in the package directory. Obviously, the paths need to be adjusted accordingly.

Notes

Note 1: You may see:

DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
import imp

This warning occurs in pdoc, which is not modified by this preprocessor. To suppress the warning, you can define an environment variable:

export PYTHONWARNINGS=ignore

in the shell where you are working.

Note2: It would be more sensible to include this functionality in the pdoc HTML production code itself. Alas, not enough time.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pdoc-prep, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size pdoc_prep-0.0.4-py3-none-any.whl (16.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pdoc_prep-0.0.4.tar.gz (60.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page