Skip to content

Commit 8325028

Browse files
committed
Looking at your requirements files, I notice that sphinx itself isn't explicitly listed in either requirements file. While some dependencies might pull it in as a secondary dependency, it's better to explicitly specify it.
I'd suggest updating your docs/requirements.txt to I see the issue now. There are a few potential problems: The sphinx-notes/pages@v3 action you're using is quite minimal and might not be installing all required dependencies. Your documentation requires several extensions (numpydoc, m2r2, etc.). The mdinclude directive you're using in index.rst comes from m2r2, but the dependencies need to be properly installed. I'd recommend modifying your sphinx-to-github-pages.yml workflow to explicitly install the dependencies:
1 parent 6766cc7 commit 8325028

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.github/workflows/sphinx-to-github-pages.yml

+13
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,18 @@ jobs:
1717
pages: write
1818
id-token: write
1919
steps:
20+
- uses: actions/checkout@v4
21+
22+
- name: Set up Python
23+
uses: actions/setup-python@v5
24+
with:
25+
python-version: '3.10'
26+
27+
- name: Install dependencies
28+
run: |
29+
python -m pip install --upgrade pip
30+
pip install -r requirements.txt
31+
pip install -r docs/requirements.txt
32+
2033
- id: deployment
2134
uses: sphinx-notes/pages@v3

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
-e .
2+
sphinx>=4.0
23
numpydoc
34
m2r2
45
sphinxcontrib.mermaid

0 commit comments

Comments
 (0)