[WIP] Include static files in config and to sidebar, #115 #394
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 thepdoc/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 bypdoc/pdoc/cli.py
Lines 572 to 582 in 2cce30a
So I guess one needs to include these static files in the
modules
variable. My problem is that theconfig.mako
is not parsed by thecli.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