Skip to content

Commit

Permalink
Document private items in dev-docs (bevyengine#14769)
Browse files Browse the repository at this point in the history
# 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.
  • Loading branch information
BD103 authored Aug 15, 2024
1 parent eec3800 commit 2012f13
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ jobs:
--all-features \
--workspace \
--no-deps \
--document-private-items \
--exclude ci \
--exclude errors \
--exclude bevy_mobile_example \
Expand Down

0 comments on commit 2012f13

Please sign in to comment.