Skip to content

Demonstrates a potential bug in sphinx-immaterial theme.

Notifications You must be signed in to change notification settings

peske/sphinx-immaterial-bug

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What?

A dummy Python project that illustrates a potential bug in https://github.com/jbms/sphinx-immaterial.

Reproduce

pip install -R requirements.txt
cd ./docs
make html

This will result in the following error:

Extension error (sphinx_immaterial.apidoc.python.apigen):
Handler <function _builder_inited at 0x7ff079d9d8a0> for event 'builder-inited' threw an exception (exception: Cannot set values to nptyping.NDArray.)
make: *** [Makefile:20: html] Error 2

If we exclude dummy/typing.py module by commenting it out in docs/source/conf.py:

# Python apigen configuration
python_apigen_modules = {
    "dummy": "api/dummy.",
    # "dummy.typing": "api/dummy.typing.",
}

and try again:

make html

the error goes away.

Note

I'm not sure if the error is caused by sphinx-immaterial, sphinx, or nptyping package.

About

Demonstrates a potential bug in sphinx-immaterial theme.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages