You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: audit-cli/README.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ audit-cli
59
59
│ └── find-string
60
60
├── analyze # Analyze RST file structures
61
61
│ ├── includes
62
-
│ └── references
62
+
│ └── file-references
63
63
└── compare # Compare files across versions
64
64
└── file-contents
65
65
```
@@ -223,9 +223,9 @@ With `-v` flag, also shows:
223
223
224
224
#### `analyze includes`
225
225
226
-
Analyze `include` directive and `toctree`relationships in RST files to understand file dependencies.
226
+
Analyze `include` directive relationships in RST files to understand file dependencies.
227
227
228
-
This command recursively follows both `.. include::` directives and `.. toctree::` entries to show all files that are referenced from a starting file. This provides a complete picture of file dependencies including both content includes and table of contents structure.
228
+
This command recursively follows `.. include::` directives to show all files that are referenced from a starting file. This helps you understand which content is transcluded into a page.
229
229
230
230
**Use Cases:**
231
231
@@ -234,7 +234,7 @@ This command helps writers:
234
234
- Identify circular include dependencies (files included multiple times)
235
235
- Document file relationships for maintenance
236
236
- Plan refactoring of complex include structures
237
-
-Understand table of contents structure and page hierarchies
237
+
-See what content is actually pulled into a page
238
238
239
239
**Basic Usage:**
240
240
@@ -286,6 +286,12 @@ times (e.g., file A includes file C, and file B also includes file C), the file
286
286
However, the tree view will show it in all locations where it appears, with subsequent occurrences marked as circular
287
287
includes in verbose mode.
288
288
289
+
**Note on Toctree:**
290
+
291
+
This command does **not** follow `.. toctree::` entries. Toctree entries are navigation links to other pages, not content
292
+
that's transcluded into the page. If you need to find which files reference a target file through toctree entries, use
293
+
the `analyze file-references` command with the `--include-toctree` flag.
294
+
289
295
#### `analyze file-references`
290
296
291
297
Find all files that reference a target file through RST directives. This performs reverse dependency analysis, showing which files reference the target file through `include`, `literalinclude`, `io-code-block`, or `toctree` directives.
@@ -382,8 +388,7 @@ With `--include-toctree`, also tracks:
382
388
getting-started
383
389
```
384
390
385
-
**Note:** Only file-based references are tracked. Inline content (e.g., `.. input::` with `:language:` but no file path) is not tracked.
386
-
391
+
**Note:** Only file-based references are tracked. Inline content (e.g., `.. input::` with `:language:` but no file path) aly
0 commit comments