Comments (2)
Hi @samuelmurail - thanks for the report.
Is it expected to install numpy to build the documentation ?
Generally it is the case that when Sphinx builds Python-based documentation, it reads and evaluates the Python code files within the project.
So in general, it is necessary for your project's Python code to evaluate successfully, including resolution of module imports, etc. As you've found, there are some options to allow mocking-out individual imports in cases where it isn't desirable to have those installed at doc-build-time.
I'm not hugely familiar with cpython
, but my guess is that the cimport
statement is not mocked out by autodoc_mock_imports
-- and that when it is evaluated, it attempts to load some numpy
Python modules that you don't have available, causing the module's evaluation (and then your Sphinx project build) to fail.
from sphinx.
I'm not certain that this is a bug, so I'm going to remove the label and relocate this thread into the GitHub discussions area until we confirm either that this is in fact a bug, or perhaps figure out a feature request / enhancement proposal from it.
from sphinx.
Related Issues (20)
- LaTeX: footnote mark may indicate "Page N, M" but footnote M is already on page N
- Gettext builder cannot extract 'option' directive HOT 4
- `autodoc_class_signature = "separated"` cause a warning for enum with no `__init__` HOT 12
- [search] issues with the new HTML search algorithm HOT 15
- Pre-declared explicit links not working
- add_css_file return wrong URI when dealing with local files on windows platform HOT 6
- [search] Add ability to treat "-" as a normal letter, to not split search term into several words HOT 1
- Import command-line documentation from docopt HOT 2
- Add "skip to main content" a11y feature
- BUG: env.toctree_includes different between parallel and serial builds HOT 2
- LaTeX: for French language and lualatex engine polyglossia and not babel is used contrarily to Sphinx documentation
- [docs] clarify the usage of `versionadded` & co HOT 9
- Re: :scale: for SVG images in HTML builds
- sphinx raises an exception when trying to build python 3.13 doc with devhelp HOT 3
- Yandex Browser ignores the translation ban HOT 1
- TypeError: expected str, bytes or os.PathLike object, not StringList HOT 7
- test_autodoc_type_aliases failing on 3.12.4 HOT 3
- error on http link containing a dash with sphinx book/pydata theme HOT 4
- Make complex setting values like latex_documents overridable HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinx.