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.14k stars 146 forks source link

generating the whole project documentation with 1 command #413

Closed GiiRiX closed 2 years ago

GiiRiX commented 2 years ago

Expected Behavior

ately i've started using pdoc3 to document my whole project, right now i have a problem generating a HTML that contain the whole project in 1 command, and not going every.py file one by one

the project structure is like this:

--pythonProject
    |  file_a.py
    |  file_b.py
    --folder
        |  file_c.py
        |  file_d.py
    --docs

Actual Behavior

i tried the following command : pdoc --html .\fila_a.py --output-dir docs --force --config "lunr_search={}" and it genetrates the following file in docs folder -> file_a.html is there a way to generate 1 file for all the .py files i have in code? also tried pdoc --html .\ --output-dir docs --force --config "lunr_search={}" but getting an error for pytest library that not in my project at all also tried pdoc --html pythonProject --output-dir docs --force --config "lunr_search={}" and it says that it cant find module pythonProject

Steps to Reproduce

  1. pdoc --html .\ --output-dir docs --force --config "lunr_search={}"
  2. return error for pytest library

Additional info

GiiRiX commented 2 years ago

after digging a little bit further inside all the issues tab in this repo, i successfully found the missing peice of the puzzle :)

ComanderKai77 commented 1 year ago

@bananisacte Would you mind sharing your solution?