Skip to content
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

How to create link between rustdoc and mdbook? #1356

Open
robinmoussu opened this issue Oct 17, 2020 · 0 comments
Open

How to create link between rustdoc and mdbook? #1356

robinmoussu opened this issue Oct 17, 2020 · 0 comments

Comments

@robinmoussu
Copy link

In case this is a A/B problem, what I'm trying to do is to have both a API centrist documentation (with rustdoc), and a global overview (with mdbook).

All the documentation (rustdoc + mdbook) is going to be build locally. I can use relative path to locate the root of the crate or the root of the mdbook (it will be in a documentation subdirectory of my crate).

I would like to add links to and from rustdoc and mdbook. Is it somehow possible? Ideally I would like to be able to use struct.MyType.html into the mdbook, and have the url pointing to the relevant rustdoc section.

Note 1: I don't have a place to host neither the mdbook nor the output of rustdoc, so I can't just use absolute url.
Note 2: I posted this very question on the user forum without any answers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant