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

Integrating external Documentation #691

Closed
Schorny opened this Issue Jul 14, 2015 · 2 comments

Comments

Projects
None yet
3 participants
@Schorny

Schorny commented Jul 14, 2015

I have a documentation written in mkdocs and an API documentation that gets created automatically from the source code.
I currently just use external links inside my mkdocs to link to my API docu, which works fine. But I can't set the API docu as one of the pages target.
And also mkdocs does not copy the API documentation when doing mkdocs build or mkdocs serve, even though it resides in the docs_dir.

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).

@samuelcolvin

This comment has been minimized.

Contributor

samuelcolvin commented Jul 17, 2015

👍

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 .html files which definitely are media files in this context (the whole premise of bokeh is that html can be used as a format for self contained interactive plots) are excluded.

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.

@d0ugal d0ugal added the Bug label Jul 17, 2015

@d0ugal

This comment has been minimized.

Member

d0ugal commented Jul 17, 2015

Yeah, good point - that is a regression.

@d0ugal d0ugal added this to the 0.15.0 milestone Jul 17, 2015

d0ugal added a commit to d0ugal/mkdocs that referenced this issue Jul 25, 2015

d0ugal added a commit to d0ugal/mkdocs that referenced this issue Jul 25, 2015

@d0ugal d0ugal closed this in #695 Jul 25, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment