How to document global variables

[KyleKing]

For example, in a definitions.py file, I might have:

"""Definitions: Create Global Reference Variables."""

import math
from pathlib import Path

# Base directory path
PTH_PROJ = Path.home() / 'Program Files (x86)/FooBar'

# Some Dictionary
COUNT_MAP = {
    'one': 1,
    'eleven': 11,
    'septendecillion': math.pow(10, 54),
}

Is there a way to show these public global variables (PTH_PROJ and COUNT_MAP) in the generated pdoc documentation?

[kernc]

Yes, you can document public variables by using PEP 224-proposed docstrings for variables, i.e. string literal directly following variable assignment:

PTH_PROJ = Path.home()
"""Base directory path"""

COUNT_MAP = {}
"""Some dictionary"""

[KyleKing]

Awesome, thanks!