Skip to content

Integrating external Documentation #691

Description

@Schorny

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions