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

[WIP] Include static files in config and to sidebar, #115 #394

Open braniii opened 2 years ago

braniii commented 2 years ago

I would like to add the possibility of including files in the table of contents. As a first step we will focus only on including markdown files. In a next PR this should be extend to support .ipynb and .html. My idea is to add a dictionary in the pdoc/templates/config.mako where the user can specify the name of the toc as key and the value as the path of the markdown document.

@kernc I am new to mako and struggling with some basic tasks. My concept requires to create html files for each included Markdown file. If I got it correctly, the html/md files are generated by https://github.com/pdoc3/pdoc/blob/2cce30a9b55eeeddc1ed826c8a2ada53777c3eea/pdoc/cli.py#L572-L582 So I guess one needs to include these static files in the modules variable. My problem is that the config.mako is not parsed by the cli.py. Can you point me to an ansatz on how to circumvent this issue?

Thank you so much for your help and this great project