pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.12k stars 145 forks source link

Central index.html for multi project build #305

Closed Kaiser1989 closed 3 years ago

Kaiser1989 commented 3 years ago

Expected Behavior

When buildings pdoc for multiple projects with pdoc --html project-a project-b project-c i would expect to get a single documentation containing docs for all 3 projects. Meaning one central index.html and links between all of them.

Actual Behavior

I get 3 folders with docs for each project seperately. There is no way to combine them. Links are working as expected, but i'm missing a starting index.html

Steps to Reproduce

  1. Create 3 projects (project-a, project-b, project-c)
  2. pdoc --html project-a project-b project-c

Additional info

Usecase

I provide some python sdk for native libraries, where some packages are used as base packages, to sum up functions used in other packages. We are doing the same for Java, Rust & C. As our packages are build on each other, it would be nice to include other packages to documentation as well, so users do not have to load the docs for each package seperately.

Javadoc & Doxygen are supporting such combinations:

Any ideas how this can be realized?

Kaiser1989 commented 3 years ago

duplicate of #101