From 2012f13c0576caa56af81b03d7a77c0f1289ed2b Mon Sep 17 00:00:00 2001
From: BD103 <59022059+BD103@users.noreply.github.com>
Date: Thu, 15 Aug 2024 16:57:49 -0400
Subject: [PATCH] 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.
---
 .github/workflows/docs.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index a253ec153d..17ac22019e 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -67,6 +67,7 @@ jobs:
             --all-features \
             --workspace \
             --no-deps \
+            --document-private-items \
             --exclude ci \
             --exclude errors \
             --exclude bevy_mobile_example \