Skip to content

Central index.html for multi project build #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Kaiser1989 opened this issue Jan 27, 2021 · 1 comment
Closed

Central index.html for multi project build #305

Kaiser1989 opened this issue Jan 27, 2021 · 1 comment
Labels
duplicate This issue or pull request already exists enhancement New feature or request

Comments

@Kaiser1989
Copy link

Kaiser1989 commented Jan 27, 2021

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

  • python version: 3.8.2
  • pdoc version: 0.9.2

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:

  • You can define multiple source inputs, building a single documentation out of it

Any ideas how this can be realized?

@Kaiser1989 Kaiser1989 changed the title Include additional packages to documentation Central index.html for multi project build Jan 27, 2021
@Kaiser1989
Copy link
Author

duplicate of #101

@kernc kernc added duplicate This issue or pull request already exists enhancement New feature or request labels Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists enhancement New feature or request
Development

No branches or pull requests

2 participants