How to stop mdbook from looking for summary.md in inner crate.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Bug
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start with the book.toml source setting and the mdbook build error for wgpu-examples/src. Determine why that directory is treated as a book source despite the configured "src" path, then document or implement a way to keep the external example crate separate while allowing the preprocessor to link its examples.
Written by the indexing model from the issue text.
Description
Question
I'm trying to make a book about a Rust library. The problem is that 1. mdbook does not accept external crates and 2. the code examples are so big, I want to store them in a separate crate to test and then preprocessor link to the examples. The problem is that mdbook is trying to get a summary.md out of this sub crate. I get
mdbook build
2023-07-28 22:29:34 [ERROR] (mdbook::utils): Error: Couldn't open SUMMARY.md in "/Users/personal/Desktop/projects/unofficial-wgpu-book/wgpu-examples/src" directory
2023-07-28 22:29:34 [ERROR] (mdbook::utils): Caused By: No such file or directory (os error 2)
How do I stop it from trying to use this directory for the source? I have the source directory specified in book.toml as "src".
Version
mdbook v0.4.32
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from rust-lang/mdBook
-
C-bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
C-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
C-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
C-enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
All issues in rust-lang/mdBook
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bevyengine/bevy#25861 ·
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
enhancement remote
Difficulty 2/5 1-3 hours Newbie friendliness 68/100