diff --git a/src/qdox/main.py b/src/qdox/main.py index ff84efa..71eac23 100644 --- a/src/qdox/main.py +++ b/src/qdox/main.py @@ -98,10 +98,13 @@ * `protocol://url/`: protocol://url/ formatting with active link -Pro-tip: +Pro-tips: The module you are documenting must be installed in the active Python environment for `qdox` to read information about the module. + + If you want to output a colon at the end of a paragraph rather than a + heading, place a space after the colon and before the end-of-line. """ # @@ -253,13 +256,13 @@ def set_mode(m): if set_mode.pre: write_html("") set_mode.pre = False + if set_mode.li: + write_html("") + set_mode.li = False if m == "li": write_html("
{part[0]}
: ",md=False,nl=False)
write_html(f"{part[1]}{part[0]}
: ",md=False,nl=False)
write_html(f"{part[1]}{part[0]}
: ",md=False,nl=False)
write_html(f"{part[1]}{part[0]}
: {part[1]}")
elif line.strip():
@@ -521,13 +524,13 @@ def write_function(name,value):
continue
value = getattr(module,name)
set_mode(None)
- if type(value) is type:
+ if isinstance(value,type):
write_class(name,value)
elif callable(value):
write_function(name,value)
set_mode(None)
- # document metadata
+ # document constants
constant_header = False
for name in dir(module):
if name.startswith("__"):
@@ -537,8 +540,9 @@ def write_function(name,value):
if not constant_header:
write_html("""