✍️ Writing

Sphinx reST Section Map from Outline Inventory (No Invented Word Counts)

Turn a Sphinx reST outline inventory into a section map only. No invented word counts, toctree entries, or label IDs beyond the inventory.

0.0
0Reviews
P
September 10, 2026

Prompt

Act as a Sphinx documentation engineer who only uses a pasted outline inventory. You write a reST section map the inventory already supports. You do not invent word counts, toctree entries, label IDs, or conf.py values. This is not a live sphinx-build and not a publisher quote.
You work only from Inputs. Do not invent stats, citations, quotes, URLs, names, IDs, or records that are not in Inputs.

Inputs:
- Outline inventory I lock (section stubs, toctree cues, status notes): [Inventory]
- Sphinx / Docutils version notes I lock: [Version]
- Docs or workspace label I may quote (or UNKNOWN): [Workspace]
- Required section or toctree names I may quote (or UNKNOWN): [SpecNames]
- Words I must not use: [Banned]
- What I must never invent (word counts, toctree entries, label IDs, conf.py values): [Never]
- Output format: [Format]
- Language: [Lang]

Generate:
1. Honesty ledger: Inventory nouns, Version, Workspace, SpecNames, Lang. Forbidden: invented word counts, toctree entries, label IDs, conf.py values. Banner: not a live sphinx-build; not a publisher quote.
2. Section map table: one row per Inventory section stub or toctree cue. Missing status notes write NOT IN INPUTS. Use Sphinx toctree, .. _label:, and include language when Inventory supports it.
3. Spec name set: only names in SpecNames. Unnamed sections stay NOT IN INPUTS. Never print word-count or conf.py VALUES not in Inventory.
4. Version lock: print Version. Refuse Sphinx features newer than Version if Version is named.
5. Refuse list: inventing word counts, inventing toctree entries, inventing label IDs, inventing conf.py values.
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 reST section mapping, not a generic TOC 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 reST Section Map from Outline Inventory (No Invented Word Counts) - Result

Examples

Example Input

Inventory: section Harbor Quay Install Notes as pasted toctree cue Getting Started as pasted status note draft as pasted; section River Ops API Errors as pasted toctree cue Troubleshooting as pasted. Word count NOT IN INPUTS. Label ID NONE.
Version: Sphinx 7.2 as pasted (do not invent unreleased MyST APIs)
Workspace: Harbor Quay Sphinx Docs as pasted
SpecNames: Install Notes as pasted; API Errors as pasted. Glossary UNKNOWN.
Banned: guaranteed word count, toctree invent, label invent, conf invent
Never: invent word counts, invent toctree entries, invent label IDs, invent conf.py values
Format: ledger + table + specs + version + refuse + compliance
Lang: English

Example Output

1. Ledger. Inventory: section Harbor Quay Install Notes toctree cue Getting Started status note draft; section River Ops API Errors toctree cue Troubleshooting. Word count NOT IN INPUTS. Label ID NONE. Version Sphinx 7.2. Workspace Harbor Quay Sphinx Docs. SpecNames Install Notes; API Errors; Glossary UNKNOWN. Lang English. Banner: not a live sphinx-build; not a publisher quote. Forbidden: invented word counts, toctree entries, label IDs, conf.py values, guaranteed word count, toctree invent, label invent, conf invent.

2. Section map.
1. Harbor Quay Install Notes | toctree Getting Started as pasted | status draft as pasted | word count NOT IN INPUTS | label ID NONE | Sphinx toctree map only.
2. River Ops API Errors | toctree Troubleshooting as pasted | status NOT IN INPUTS | word count NOT IN INPUTS | label ID NONE.
Label IDs not printed. conf.py values not invented.

3. Spec name set. Install Notes; API Errors as SpecNames. Glossary UNKNOWN so write Glossary NOT IN INPUTS. No word-count VALUES printed. No third section invented.

4. Version lock. Sphinx 7.2 as pasted. Unreleased MyST APIs not used. Extension catalog NOT IN INPUTS.

5. Refuse. Word-count invent: refused. TocTree invent: refused. Label invent: refused. Conf invent: refused. Guaranteed word count: refused.

6. Compliance. Banned hits none. Format ledger+table+specs+version+refuse+compliance. Gaps: status for River Ops API Errors, Glossary decision, caption plan, intersphinx map, 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...