select modules to include in index

[hyukim17]

The default html server index, in Python module list, includes all available Python modules. Is there a way to restrict which modules show up here?

[BurntSushi]

Yes. Pass the --only-pypath option to pdoc and set your PYTHONPATH environment variable to point to the packages you want documented.

[hyukim17]

Got it. I am creating a temporary environment, overwriting PYTHONPATH, and running pdoc within that environment.

[hyukim17]

Is there a way to exclude certain modules?

[BurntSushi]

Yes. Don't put them in your PYTHONPATH.

[hyukim17]

What I mean is, what if a folder contains multiple modules?

[BurntSushi]

Ah. There is no specific command line flag to hide modules. The standard mode of operating is to have an entry in PYTHONPATH for each module you want to document. This implies that there is a single module in each of those directories. This works well in practice as a convention because it corresponds precisely to an idiomatic Python package (which usually contains at most one direct sub-directory with an __init__.py file).

[hyukim17]

ok, understood, I guess it makes more sense for me to clean up my directory structure

[gvvka0327]

I tried the suggest to put the modules I want to show up, in PYTHONPATH; no output on the html page

-bash-4.1$ echo $PYTHONPATH
/users/test/system-test/lib

pdoc --http --http-host= --only-pypath

[r2ad]

This worked well for me:

#!/bin/bash
PYTHONPATH=`pwd`
export PYTHONPATH
pdoc --http --only-pypath