Document private items in dev-docs (#14769)

# Objective

- The [developer docs](https://dev-docs.bevyengine.org) are primarily
used by developers, who often deal with internal and private functions.
- @mweatherley suggested [on
Discord](https://discord.com/channels/691052431525675048/743559241461399582/1273658470134186112)
that CI passes `--document-private-items` to the dev-docs, so
contributors can easily browse these internal details.

## Solution

- Add `--document-private-items` to the CI job that builds the dev-docs.

## Testing

- It should run in CI and generate documentation for private code.

## Drawbacks

- Users that track the main branch may use the dev-docs instead of
<https://docs.rs/bevy>, which may now show a lot of unwanted internal
details.
- Searching may be slower / bloated with internal details.
This commit is contained in:
BD103 2024-08-15 16:57:49 -04:00 committed by GitHub
parent eec38004a8
commit 2012f13c05
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -67,6 +67,7 @@ jobs:
--all-features \ --all-features \
--workspace \ --workspace \
--no-deps \ --no-deps \
--document-private-items \
--exclude ci \ --exclude ci \
--exclude errors \ --exclude errors \
--exclude bevy_mobile_example \ --exclude bevy_mobile_example \