sphinx-doc / sphinx-doc/sphinx

Intersphinx :any: references to link targets with capital letters fails

Open
#8,982 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

extensions:intersphinx type:bug
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Unzip Sphinx_projects.zip, then:

cd two
make html
cd ../one
make html

This illustrates the following problems:

From one/index.rst

image

From two/index.rst

image

Bugs observed

  1. The :any: tag fails to find Intersphinx tags that contain capital letters.
  2. The :any: tag produces an odd visual style for Intersphinx links; I would expect them to render identically to any other link (such as the standard style produced by using :ref:.)

Inconsistencies

  1. Links produced by :ref: render based on the capitalization of the link target. Links produced by the Docutil syntax render based on the capitalization of the link reference. I would expect these to render identically.

Thanks

Sphinx is amazing and I use it every day. Thanks for creating and maintaining such as amazing tool!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Unzip Sphinx_projects.zip and run make html in two, then one to reproduce the behavior described in one/index.rst and two/index.rst. Compare the :any: and :ref: output for targets containing capital letters and the Docutils links. Done means capitalized Intersphinx targets resolve and the affected links render consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.