Skip to content
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

No global index generated on html build when building multiple modules #218

Closed
pwoolvett opened this issue Jun 17, 2020 · 1 comment
Closed
Labels
duplicate This issue or pull request already exists

Comments

@pwoolvett
Copy link

pwoolvett commented Jun 17, 2020

When building several modules's doc into html, there should be a global index.html, encompassing all modules.

Expected Behavior

  • A global "index.html" file created indexing all documented modules, just like when running the server

  • links from the generated htmls back to the "parent" index.

    pdoc --html mod1.py mod2.py ->

    html
    |-- mod1.html
    |-- mod2.html
    |-- index.html

Actual Behavior

Every module documented, no global index, no back refs
pdoc --html mod1.py mod2.py ->

html
|-- mod1.html
|-- mod2.html
|-- index.html

Steps to Reproduce

  1. have (at least) two modules/packages to document
  2. run pdoc3 --html mod1.py mod2.py
  3. look into build folder: no global "index.html" found

Additional info

  • pdoc version: 0.8.1
  • related: best practices for GitHub pages? #55
  • My project currently has the following structure:
    .
    |-- manage.py
    |-- metrics
    |-- my_package
    |-- tests
    All my "production" code lives inside my_package folder, but for devs I'd like to also publish the rest of the codes documentation (namely, manage.py, metrics, tests) .It would be nice to have all documentation in one place, just like the http server does.
@kernc
Copy link
Member

kernc commented Jun 18, 2020

Duplicate of #101. Please subscribe to that bug for notifications. Welcome to try to fix it, too! 😄

@kernc kernc added the duplicate This issue or pull request already exists label Jun 18, 2020
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
Development

No branches or pull requests

2 participants