Repository navigation
autodoc&autosummary fails for uppercase/lowercase class/function #4874
Description
Error: toctree references unknown document for class and function with same name, one uppercase, one lowercase.
Problem
Having a module which contains a class Colorbar and a function colorbar, it seems impossible to get a working documentation out with autodoc and autosummary.
Procedure to reproduce the problem
class Colorbar():
# ...
def colorbar():
# ...
result when calling make html is
D:\xyz\doc\source\_as_gen\colorbar.rst:29:
WARNING: toctree references unknown document ' _as_gen/colorbar.colorbar'
There is a document
_as_gen\colorbar.Colorbar.rst produced. But no _as_gen\colorbar.colorbar.rst (probably as expected due to the os not differentiating between upper and lower case).
Reproducible project / your project
A runnable example can be found here:
Environment info
- OS: Windows 8.1
- Python version: 2.7
- Sphinx version: 1.7.1
Activity
tk0miya commentedon Apr 21, 2018
I guess filesystem of windows causes this problem. It ignores the case of characters.
I can't think of any good ideas or workarounds for this trouble...
jfbu commentedon Apr 22, 2018
The very same problem is confirmed on MacOS X. (thanks for the example project)
tk0miya commentedon Apr 22, 2018
AFAIK, (old?) MacOS also uses case-insensitive filesystem...
On my macbook air, it is easily reproduced:
Unfortunately, two major OS chooses case-insensitive file system by default. So we need to avoid such trouble.
jfbu commentedon Apr 22, 2018
@tk0miya afaik the default for all MacOS (old and new) is case-insensitive. But it is possible in recent MacOSes to decide for case-sensitive at install time. If not done initially, then a re-format of hard drive is needed..
larsoner commentedon Apr 26, 2023
For anyone else who stumbles around this, it looks like one workaround is to use autosummary_filename_map.