Autogenerating stubs on case-insensitive filesystem sometimes fails

[shimizukawa]

If I attempt to autogenerate API docs for a class that has two method names that are identical except for uppercase/lowercase, autogeneration will fail on case-insenstive filesystems.

I ran into this today generating documentation for a class that sublcasses Sympy's Expr class. Expr defines both as_coeff_Add and as_coeff_add as member functions.

When the autosummary extension tries to autogenerate stub .rst files for these two functions, it fails on the second one because the os.path.isfile() call here will return True.

I'd ignore the issue except for the fact that it generates thousands of warning messages in my builds logs, since sphinx still tries to access the nonexistent file every time it traverses the toctree.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/1495
• Originally reported by: Nathan Goldbaum
• Originally created at: 2014-06-24T07:20:51.563

[wesm]

This issue still comes up from time to time. Is this fixable in Sphinx?

[tk0miya]

I set 2.0 milestone to this ticket. I'll take a look later (or post-2.0 release).

[thomasjpfan]

A solution to this issue would require renaming the filenames if we are on a case insensitive file system. If we were to do it automatically, we would need a naming convention such as adding a count at the end of files, such as 'FILENAME1.rst, filename2.rst`, lexically ordered.

[shaunc]

Grumble ... just took the trouble to learn sphinx and rewrite my doc strings to conform only to run into this. Is there any workaround? Or a branch I could use? Sphinx looks quite mature with all kinds of specialized support from the outside, but for me this is quite a basic issue. It's startling that it doesn't work. (MacOS)

[matteha]

Can confirm it doesn't work on Fedora either (btrfs filesystem by default).