diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 998ee30f..70f2721f 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -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}}) diff --git a/Makefile b/Makefile index e28e4498..0c8f5c62 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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 diff --git a/docs/conf.py b/docs/conf.py index fb8263d4..47b1b225 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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("../")) @@ -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. @@ -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"]