sphinx-doc / sphinx-doc/sphinx
no interpage links in texinfo output
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
I can not get any of the interpage cross reference roles to work in texinfo output. It does work if I use info: links, but those are not what I want for HTML output.
How to Reproduce
the attached zip is the output from quick-start, with two added pages page1.rst and page2.rst.
When I run the HTML writer, I get a link from page1 to page2, as expected. When I run the texinfo writer, I just get a literal (@ code) of the label-name.
report.zip
Environment Information
text Platform: linux; (Linux-6.0.0-2-amd64-x86_64-with-glibc2.36) Python version: 3.10.9 (main, Dec 7 2022, 13:47:07) [GCC 12.2.0]) Python implementation: CPython Sphinx version: 5.3.0 Docutils version: 0.17.1 Jinja2 version: 3.0.3
Sphinx extensions
No response
Additional context
No response
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
Start with the attached report.zip and reproduce the page1-to-page2 cross-reference using Sphinx's HTML and Texinfo writers. Compare the working HTML link with the Texinfo output, where the label is emitted literally; done when interpage cross-reference roles generate usable Texinfo links rather than label text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100