Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Documentation paths are ambiguous on case insensitive file systems

See original GitHub issue

Master’s documentation build produces files including:

modules/generated/sklearn.cluster.dbscan.html
modules/generated/sklearn.cluster.DBSCAN.html
modules/generated/sklearn.cluster.optics.html
modules/generated/sklearn.cluster.OPTICS.html

These paths will not work well on file systems that are case insensitive. Does anyone know of a way to make the sphinx autogen functionality generate alternative names in this case? Ideally we would do so in a way that keeps sklearn.cluster.DBSCAN.html which has existed in previous releases, while sklearn.cluster.dbscan.html did not.

We could also do post-processing so that documentation packages can be shared with case insensitive platforms, even if they cannot be generated on case-insensitive platforms.

Discovered in the context of https://github.com/Kapeli/Dash-User-Contributions/pull/2143

Issue Analytics

State:
Created 5 years ago
Comments:9 (7 by maintainers)

Top GitHub Comments

1reaction

adrinjalalicommented, Dec 17, 2018

If you’re comfortable with sphinx, sure, go ahead.

0reactions

thomasjpfancommented, Jun 19, 2021

Closing because we are using autosummary_filename_map to resolve this issue.

Top Results From Across the Web

java - How to ensure case-sensitive resource is what I look for ...

Normally, several paths are tried to look for the correct file. On a case-insensitive system, however, it is possible the wrong file is...

Adjust case sensitivity - WSL - Microsoft Learn

Learn how case sensitive file names are handled between Windows and Linux file systems, how to adjust these settings by directory with WSL, ......

Case sensitivity - Wikipedia

In computers, case sensitivity defines whether uppercase and lowercase letters are treated as distinct (case-sensitive) or equivalent (case-insensitive).

Case Insensitive File Systems - Canonical

Case -insensitive: This is the file-system used by very old Windows versions and is rarely encountered "in the wild". Two files that differ...

settings.json properties - IBM

Default is false to match files with all cases in the path. Set it to true to avoid ambiguous matching on case-insensitive file...