How to use pdoc on a script that takes command line args?

Question

I'm trying to use pdoc to document my python script but I'm having an issue due to the fact that my program requires the use of command line args.

My program is called as follows: myprogram.py -p arg1 -s arg2

And I try to run pdoc as follows: pdoc --html myprogram

But I get an error saying pdoc: error: the following arguments are required: -p

But if I try to run pdoc like such: pdoc --html myprogram.py -p arg1 -s arg2, I get this error:

pdoc: error: unrecognized arguments: -p arg1 -s arg2

IS there a way to run pdoc on a module that requires command line args?

Answer 1

Since pdoc imports the documented modules, you need to nest your CLI program execution under a main guard:

def main():
    from argparse import ArgumentParser
    parser = ArgumentParser(...)
    args = parser.parse_args()
    ...

if __name__ == '__main__':
    # Run main entry point only if the script was run as a program
    # and not if it was merely imported
    main()