Join GitHub today
Integrating external Documentation #691
I have a documentation written in mkdocs and an API documentation that gets created automatically from the source code.
Is there any way to "integrate" external documentation in a mkdocs project? basically all I really need is an "asset dir" where I can dump the external documentation and mkdocs just copies it for me 1:1 when doing build or serve and for mkdocs to allow me to link to these assets.
It works fine with images, but somehow with HTML files mkdocs likes to mess with them (changing them or deleting them entirely).
The problem is here:
and not is_html_file(filename)
mkdocs is excluding all html files.
Would be great if this could be changed so html documents could be included when serving, building or deploying, I guess via a switch which defaulted to false so current default functionality isn't changed.
I have the same problem with bokeh.github.io/Bokeh.jl the plot
In this case I use
rm -r site/; mkdocs build; cp -r docs/examples/ site/; ghp-import -p site/
to ignore mkdocs and deploy the html files to github pages anyway.