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)
- Cross-referencing foreign custom directives HOT 1
- LaTeX writer imposes too many constraints on desc_type_parameter_list nodes HOT 4
- 7.4.0 release plan HOT 19
- [HTML theme] add "Navigate to the Top" button HOT 27
- Regression: localization of 'Anchor not found' message removed.
- Sphinx v7.4.0: Failed to get a method signature: unhashable type HOT 6
- Sphinx v7.3.7: AttributeError: 'Symbol' object has no attribute '_children' HOT 10
- Sphinx 7.4.0 breaks parsing of MyST-Parser (and probably others) configuration in conf.py HOT 4
- Warning about duplicate definitions in intersphinx mapping HOT 5
- New warning in version 7.4 from autosummary causing automated builds to fail HOT 14
- Regression in 7.4: `jinja2.exceptions.TemplateNotFound` error from `jinja2glue` HOT 3
- LaTeX regression for admonitions HOT 15
- Running make gettext fails with TypeError HOT 1
- [HTML search] Bug: 'indexentries' section missing results from search index following non-fresh project rebuild. HOT 1
- Sphinx 7.4: autodoc: ``typing.Annotated`` failure with pydantic HOT 12
- Python 3.8: `typing_extensions.Annotated` annotations not rendered correctly. HOT 1
- [HTML search] Optimization: write zero/one instead (one character) instead of true/false (four/five characters) for bool flags. HOT 1
- [HTML search] Test suite: ranking check should ensure that all entries are found.
- Exponential Increase in Build Time with Multiple :numref: References and Custom-Extension Tables HOT 2
- multiple definitions for std:label:python--m-build--v HOT 14
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.