Skip to content

Commit 975de1a

Browse files
robtaylorclaude
andcommitted
Move RST formatting scripts to docs/tools
- Created docs/tools directory for documentation utilities - Moved RST formatting scripts from root to docs/tools - Added README.md with usage instructions for the tools 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 35f7050 commit 975de1a

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

docs/tools/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Documentation Tools
2+
3+
This directory contains utility scripts for maintaining Amaranth documentation.
4+
5+
## RST Formatting Tools
6+
7+
### `fix_rst_underlines.py`
8+
9+
Automatically fixes RST title underlines to match the length of their title text.
10+
11+
Usage:
12+
```bash
13+
pdm run python docs/tools/fix_rst_underlines.py docs/file.rst
14+
```
15+
16+
### `fix_rst_bullet_lists.py`
17+
18+
Ensures all bullet lists in RST files end with a blank line, which is required by the RST parser.
19+
20+
Usage:
21+
```bash
22+
pdm run python docs/tools/fix_rst_bullet_lists.py docs/file.rst
23+
```
24+
25+
## Using These Tools
26+
27+
These tools are helpful when you encounter warnings during documentation builds. You can run them on RST files
28+
to automatically fix common formatting issues.
29+
30+
Example workflow:
31+
1. Run `pdm run document` and observe formatting warnings
32+
2. Run the appropriate fix script(s) on the problematic files
33+
3. Verify the fixes with `pdm run document` again
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)