Is there a way to get pydoc to generate docs for just a module and its submodules?

418 Views Asked by At

I know sphinx and pdoc3 exist, but I'm trying to use pydocs despite my better judgment.

This invocation

python -m pydoc -w .\\

will

  • generate docs for all modules including things I don't want such as doc for /tests/
  • put all documents in root of source folder
  • create absolute path links instead relative path links

Here is a test repo on Github.

I'd like to not generate the docs for /tests/. I'd like the output to go into the /docs/ and not junk up the root. I've already determined that we can't get relative links.

I've seen recommendations for invoking pydoc once per source file, but I don't want to change the doc generating script each time I add a new file.

0

There are 0 best solutions below