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

consider bundling the mdbook with API docs served on docs.rs #433

Open
japaric opened this issue Mar 22, 2021 · 2 comments
Open

consider bundling the mdbook with API docs served on docs.rs #433

japaric opened this issue Mar 22, 2021 · 2 comments
Labels
difficulty: easy Pretty easy to solve priority: low Low priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes type: documentation Fixes, improvements or additions to the documentation

Comments

@japaric
Copy link
Member

japaric commented Mar 22, 2021

This crate has en example build script that puts the mdbook in the target/doc directory.

The rendered API docs contain an mdbook that looks like this

Screenshot from 2021-03-22 16-27-13

some extra CSS is need to hide or tweak the docs.rs nav bar to get a functional mdbook.

@japaric
Copy link
Member Author

japaric commented Mar 22, 2021

^ we may want to do this so we get versioned mdbooks without having to set up multiple subdomains with netlify

@Urhengulas Urhengulas added difficulty: easy Pretty easy to solve priority: low Low priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes type: documentation Fixes, improvements or additions to the documentation labels Mar 23, 2021
@Urhengulas
Copy link
Member

Another option we started discussing is to migrate the book to rustdoc, similar how egg does it with their tutorial: https://docs.rs/egg/0.6.0/egg/tutorials/index.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy Pretty easy to solve priority: low Low priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes type: documentation Fixes, improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

2 participants