✍️ Writing

Sphinx toctree Chapter Map from Docs Inventory (No Invented Word Counts)

Turn a Sphinx docs inventory into a toctree chapter map only. No invented word counts, page counts, or build times beyond the inventory.

0.0
0Reviews
P
September 9, 2026

Prompt

Act as a Sphinx documentation architect who only uses a pasted docs inventory. You write a toctree chapter map the inventory already supports. You do not invent word counts, page counts, build times, or read-the-docs badges. This is not a live Sphinx build and not a docs SEO audit.
You work only from Inputs. Do not invent stats, citations, quotes, URLs, names, IDs, or records that are not in Inputs.

Inputs:
- Docs inventory I lock (chapter stubs, path cues, status notes): [Inventory]
- Sphinx / version notes I lock: [Version]
- Project or docs label I may quote (or UNKNOWN): [Workspace]
- Required chapter or path names I may quote (or UNKNOWN): [SpecNames]
- Words I must not use: [Banned]
- What I must never invent (word counts, page counts, build times, read-the-docs badges): [Never]
- Output format: [Format]
- Language: [Lang]

Generate:
1. Honesty ledger: Inventory nouns, Version, Workspace, SpecNames, Lang. Forbidden: invented word counts, page counts, build times, read-the-docs badges. Banner: not a live Sphinx build; not a docs SEO audit.
2. toctree chapter map table: one row per Inventory chapter stub or path cue. Missing status notes write NOT IN INPUTS. Use Sphinx conf.py, toctree, directives, extensions, and rst/md sources when Inventory supports it. Never print word-count VALUES not in Inventory.
3. Spec name set: only names in SpecNames. Unnamed chapters stay NOT IN INPUTS. Never print page-count or build-time VALUES not in Inventory.
4. Version lock: print Version. Refuse Sphinx features newer than Version if Version is named (no unreleased MyST AI claims).
5. Refuse list: inventing word counts, inventing page counts, inventing build times, inventing read-the-docs badges.
6. Compliance pass: quote Banned and Never hits. Cut them. Format as Format.

Constraints:
- Map from Inventory only. No invented word-count VALUES. Teach Sphinx toctree chapter mapping, not a generic outline swap.
- Honor Version. No emojis.

Instructions

Replace every [bracket] with your details before running. Works on ChatGPT, Claude, and Gemini.

Generated Output

This image was generated using the prompt above.

Sphinx toctree Chapter Map from Docs Inventory (No Invented Word Counts) - Result

Examples

Example Input

Inventory: chapter Harbor Quay Tide Preface as pasted path cue intro/preface.rst as pasted status note draft as pasted; chapter River Ops Lock Methods as pasted path cue ops/methods.md as pasted. Word count NOT IN INPUTS. Page count NONE.
Version: Sphinx 7.3 as pasted (do not invent unreleased MyST AI APIs)
Workspace: Harbor Quay Harbor Docs as pasted
SpecNames: Tide Preface as pasted; Lock Methods as pasted. Berth Glossary UNKNOWN.
Banned: guaranteed word count, page invent, build invent, badge invent
Never: invent word counts, invent page counts, invent build times, invent read-the-docs badges
Format: ledger + table + specs + version + refuse + compliance
Lang: English

Example Output

1. Ledger. Inventory: chapter Harbor Quay Tide Preface path cue intro/preface.rst status note draft; chapter River Ops Lock Methods path cue ops/methods.md. Word count NOT IN INPUTS. Page count NONE. Version Sphinx 7.3. Workspace Harbor Quay Harbor Docs. SpecNames Tide Preface; Lock Methods; Berth Glossary UNKNOWN. Lang English. Banner: not a live Sphinx build; not a docs SEO audit. Forbidden: invented word counts, page counts, build times, read-the-docs badges, guaranteed word count, page invent, build invent, badge invent.

2. toctree chapter map.
1. Harbor Quay Tide Preface | path intro/preface.rst as pasted | status draft as pasted | word count NOT IN INPUTS | pages NONE | Sphinx toctree / conf.py map only. Word-count VALUES not printed.
2. River Ops Lock Methods | path ops/methods.md as pasted | status NOT IN INPUTS | word count NOT IN INPUTS | pages NONE.
Build times not printed. Read-the-docs badges not invented.

3. Spec name set. Tide Preface; Lock Methods as SpecNames. Berth Glossary UNKNOWN so write Berth Glossary NOT IN INPUTS. No word-count VALUES printed. No third chapter invented.

4. Version lock. Sphinx 7.3 as pasted. Unreleased MyST AI APIs not used. Extension list NOT IN INPUTS.

5. Refuse. Word-count invent: refused. Page invent: refused. Build invent: refused. Badge invent: refused. Guaranteed word count: refused.

6. Compliance. Banned hits none. Format ledger+table+specs+version+refuse+compliance. Gaps: status for River Ops Lock Methods, Berth Glossary path, maxdepth for toctree, caption label, html_theme if any.

Missing-data policy: if a field was blank, write NOT IN INPUTS rather than guessing. Lock any tool version named in Inputs; if unnamed, write unknown. No invented testimonials, star ratings, or press logos. If legal, clinical, insurance, HR, education-plan, or veterinary content appears, add a one-line not-advice and de-identify banner. Quote banned-word hits and cut them. End with a gaps list of five bullets the user still owes you. Character and byte caps in the job are hard; print counts when relevant. Refuse to backfill DOIs, exam dumps, PHI, PII, or compensation promises not in Inputs.

Reviews (0)

Please login to leave a review.
Loading reviews...