sphinx-doc / sphinx-doc/sphinx
Documentation: Recipe tutorial does not explain how to use the index
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
The recipe tutorial shows how to create an index of recipes, but it never explains how to get that index to appear in the output.
To Reproduce
- Follow the recipe tutorial.
- Try to get the index to appear when you don't know how.
Expected behavior
There should be a paragraph explaining where the index is generated in the build, and how to include it in the output document, with a code sample.
Note: This may look like a request for support, but I'd like the documentation improved for all. Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked recipe tutorial and review the existing instructions for creating the recipe index. Add the requested paragraph and code sample explaining where the index is generated during the build and how to include it in the output document; done means a reader can follow the tutorial and display the index.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100