Skip to content

Pdoc exits with 0 although documentation generation partially failed #407

@lovetheguitar

Description

@lovetheguitar

Problem Description

When documenting a package and a module fails to be documented because of a missing/broken import, pdoc exits with 0.
IMHO pdoc should exit != 0, although partial documentation is generated.

Steps to reproduce the behavior:

Setup

pdoc_poc/
├── __init__.py
├── pdoc_fail.py
└── pdoc_success.py

__init__.py (empty)

pdoc_fail.py

"""This aint gonna work..."""

import non_existant_module

pdoc_success.py

"""
Thanks for developing pdoc... its really cool!
"""
  1. call pdoc pdoc_poc -o poc_html
  2. check error code echo $LASTEXITCODE -> 0

System Information

pdoc: 12.0.1
Python: 3.8.10
Platform: Windows-10-10.0.19042-SP0

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions