DOC: allow np as a module for documentation #11344
Conversation
|
hmm, segfault when building the documentation. |
|
Yeah, that is strange. Maybe a sphinx related library? |
|
See PR #11377, there is a bug in calling |
|
Does the following work better: aliases = {}
for name, module in sys.modules.items():
parts = name.split('.', 1)
if parts[0] == 'numpy':
parts[0] = 'np'
aliases[name] = module
sys.modules.update(aliases) |
|
It still may fail if new numpy c-extension imports are needed past this point, which should not be the case in documentation. |
| parts = name.split('.', 1) | ||
| if parts[0] == 'numpy': | ||
| parts[0] = 'np' | ||
| aliases[name] = module |
There was a problem hiding this comment.
I missed a line, sorry: name = '.'.join(parts)
|
Turns out that Closing this, it is the wrong approach. |
|
I think this approach would work if you then also told sphinx to generate docs for things under This might actually be a good idea from the perspective of matching source code, but worse from a search engine perspective. |
Add
npto sys.modules so that documentation can use`np.dtype`instead of`numpy.dtype`or ``np.dtype <numpy.dtype>