Skip to content

Commit

Permalink
Fix Sphinx add custom css issue (#933)
Browse files Browse the repository at this point in the history
  • Loading branch information
ubaumann authored Jun 27, 2024
1 parent 7cac01b commit 7a93f23
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jobs:
- name: Run sphinx
run: |
sudo apt-get install pandoc
make sphinx
make docs
pytest:
name: Testing on Python ${{ matrix.python-version }} (${{ matrix.platform}})
Expand Down
10 changes: 2 additions & 8 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,6 @@ docker:
pytest:
poetry run pytest --cov=nornir --cov-report=term-missing -vs ${ARGS}

.PHONY: sphinx
sphinx:
# TODO REPLACE with: sphinx-build -n -E -q -N -b dummy -d docs/_build/doctrees docs asd
# poetry run sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html
echo "WARNING: sphinx needs to be added here!!!"

.PHONY: mypy
mypy:
poetry run mypy nornir tests
Expand All @@ -43,5 +37,5 @@ docker-tests: docker

.PHONY: docs
docs:
./docs/build_api.sh
make -C docs clean html
poetry run ./docs/build_api.sh
poetry run make -C docs clean html
9 changes: 2 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
import sys
from typing import Dict

from sphinx.application import Sphinx

from nornir import __version__

sys.path.insert(0, os.path.abspath("../"))
Expand Down Expand Up @@ -70,7 +68,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -171,7 +169,4 @@

issues_github_path = "nornir-automation/nornir"


def setup(app: Sphinx) -> None:
"""Map methods to states of the documentation build."""
app.add_stylesheet("css/custom.css")
html_css_files = ["css/custom.css"]

0 comments on commit 7a93f23

Please sign in to comment.