link to externally generated static content in the same site #4860
Unanswered
ben-marengo-msmg
asked this question in
Q&A
Replies: 1 comment
-
Thanks for asking. I'm not sure how to tell MkDocs to ignore those files, so it might be a good idea asking the maintainers of MkDocs by posting on their discussion board. If you manage to solve the problem, let us know. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
i have database schema documentation that is generated by another tool. i'd like to link to it using mkdocs.
consider the following setup:
docs/database-docs.md
scenario 1
i run
mkdocs serve
which succeeds, but, as expected, displays
WARNING - Documentation file 'database-docs.md' contains a link to '../externally-generated-content/databases/my-db1.html' which is not found in the documentation files.
i then copy my
externally-generated-content
into thesite
dirnow i visit
all show the mkdocs 404 page
scenario 2
i run
mkdocs build
which succeeds, but, as expected, displays
WARNING - Documentation file 'database-docs.md' contains a link to '../externally-generated-content/databases/my-db1.html' which is not found in the documentation files.
i then copy my
externally-generated-content
into thesite
dirnow i
docker run -p "8000:80" -v "${PWD}/site/:/usr/local/apache2/htdocs/" --name docs --rm httpd:2.4
and visit the same urls
visiting 1 shows me the static directory listing of all html files
visiting 2 shows me the database documentation html
visiting 3 shows apache 404 page
my desired behaviour:
1 shows me the static directory listing of all html files
2 shows me the database documentation html
3 shows mkdocs 404 page
is it possible to register static routes that are ignored by mkdocs routing in order to get my desired behaviour?
Beta Was this translation helpful? Give feedback.
All reactions