Skip to content

Commit

Permalink
Merge pull request #2483 from retoflow/fix/GA_docs_check
Browse files Browse the repository at this point in the history
GA: fix docs_check job
  • Loading branch information
vogt31337 authored Dec 11, 2024
2 parents 41b9c2e + 6252245 commit 9757a75
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 17 deletions.
16 changes: 4 additions & 12 deletions .github/workflows/github_test_action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -290,21 +290,13 @@ jobs:
uv run pytest -W error --nbmake -n=auto --nbmake-timeout=900 "./tutorials"
docs_check:
name: Sphinx docs check
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [ '3.9' ]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Check docs for Python ${{ matrix.python-version }}
uses: e2nIEE/sphinx-action@master
- name: Check sphinx build
uses: ammaraskar/sphinx-action@7.4.7
with:
pre-build-command: "apt update && apt upgrade -y && apt install -y build-essential gfortran cmake pkg-config libopenblas-dev;
python -m pip install --upgrade pip;
python -m pip install .[docs];"
pre-build-command: "python -m pip install uv && uv pip install .[docs] --system --link-mode=copy"
build-command: "sphinx-build -b html . _build -W"
docs-folder: "doc/"
3 changes: 0 additions & 3 deletions doc/requirements.txt

This file was deleted.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Download = "https://pypi.org/project/pandapower/#files"
Changelog = "https://github.com/e2nIEE/pandapower/blob/develop/CHANGELOG.rst"

[project.optional-dependencies]
docs = ["numpydoc", "matplotlib", "sphinx", "sphinx_rtd_theme", "sphinx-pyproject"]
docs = ["numpydoc>=1.5.0", "matplotlib", "sphinx>=5.3.0", "sphinx_rtd_theme>=1.1.1", "sphinx-pyproject"]
plotting = ["plotly>=3.1.1", "matplotlib", "igraph", "geopandas>=1.0"]
test = ["pytest~=8.1", "pytest-xdist", "nbmake"]
performance = ["ortools", "numba>=0.25", "lightsim2grid==0.9.0"]
Expand All @@ -68,7 +68,7 @@ converter = ["matpowercaseframes"]
pgm = ["power-grid-model-io"]
control = ["shapely"]
all = [
"numpydoc", "sphinx", "sphinx_rtd_theme", "sphinx-pyproject",
"numpydoc>=1.5.0", "sphinx>=5.3.0", "sphinx_rtd_theme>=1.1.1", "sphinx-pyproject",
"plotly>=3.1.1", "matplotlib", "igraph", "geopandas>=1.0",
"pytest~=8.1", "pytest-xdist", "nbmake",
"ortools", "numba>=0.25", "lightsim2grid==0.9.0",
Expand Down

0 comments on commit 9757a75

Please sign in to comment.