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.

Sign up for GitHub

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

Jump to bottom

Module docs don't appear in monolithic docs.rs page #13055

Closed
NthTensor opened this issue Apr 21, 2024 · 2 comments · Fixed by #13059
Closed

Module docs don't appear in monolithic docs.rs page #13055

NthTensor opened this issue Apr 21, 2024 · 2 comments · Fixed by #13059
Labels
A-Cross-Cutting Impacts the entire engine C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation
Milestone
0.14

Comments

@NthTensor
Copy link
Contributor

NthTensor commented Apr 21, 2024 •
edited

Every bevy crate has it's own docs.rs page, and also appears as modules within the monolithic bevy documentation page. Users are usually directed to the monolithic docs, and it's what we link to on the website.

Unfortunately module level docs (like this) don't display properly on the monolithic module page (here for example). They do render properly on the individual crate docs (this is how the rendered docs should look). This means most users are loosing out on important structural documentation.
@NthTensor NthTensor added C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation A-Cross-Cutting Impacts the entire engine labels Apr 21, 2024
@alice-i-cecile
Copy link
Member

IMO we should use separate .md files for each of these, and #![doc = include_str!("path/to/docs.md")] in both locations.

@NthTensor
Copy link
Contributor Author

I agree, I'll open a PR for that really quick.

@alice-i-cecile alice-i-cecile added this to the 0.14 milestone Apr 22, 2024
@NthTensor NthTensor mentioned this issue Apr 22, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Apr 22, 2024
@NthTensor
Switch monolithic lib to module re-exports (#13059)
6b95b01 
# Objective

Makes crate module docs render correctly in the docs for the monolithic
library. Fixes #13055.

## Solution

Swap from
```rust
pub mod foo {
    pub use bevy_foo::*;
}
```
to
```rust
pub use bevy_foo as foo;
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Cross-Cutting Impacts the entire engine C-Bug An unexpected or incorrect behavior C-Docs An addition or correction to our documentation
Projects
None yet
Milestone
0.14
Development

Successfully merging a pull request may close this issue.

Switch monolithic lib to module re-exports NthTensor/bevy
2 participants
@alice-i-cecile @NthTensor