From 95d5e2906a4bdac98add829941026c4e30e8ce1f Mon Sep 17 00:00:00 2001 From: mathleur Date: Mon, 29 Jul 2024 16:02:11 +0200 Subject: [PATCH] try to fix read the docs build --- .github/workflows/ci.yaml | 5 ---- Makefile | 2 +- docs/Makefile | 57 --------------------------------------- docs/requirements.txt | 2 +- 4 files changed, 2 insertions(+), 64 deletions(-) delete mode 100644 docs/Makefile diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 394c7b05c..fb1be91ea 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -138,11 +138,6 @@ jobs: uses: codecov/codecov-action@v3 with: files: coverage.xml - - name: Documentation - run: | - python -m pip install -r docs/requirements.txt - mkdocs build --clean - working-directory: docs deploy: needs: test if: ${{ github.event_name == 'release' }} diff --git a/Makefile b/Makefile index 786ad99c1..cef86d1ed 100644 --- a/Makefile +++ b/Makefile @@ -20,4 +20,4 @@ docs: mkdocs build mkdocs serve -.PHONY: init test \ No newline at end of file +.PHONY: init test docs \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 8198cee25..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,57 +0,0 @@ -# Goal of the makefile is to simplify managing and operating application -# You need to install GNU Make on your operating system in order to call `make` command. -# Windows: http://gnuwin32.sourceforge.net/packages/make.htm (make sure path to make.exe is added to PATH) -# Ubuntu: make is already installed -# Call `make help` to see list of available commands - -# Important: when editing use *tabs* (not spaces) otherwise Makefile won't work! -# Important: each line runs in *separated subprocess*. if you need to chain commands use: cmd1 && cmd2 - -# --------- -# Variables -# --------- -# Project root directory -PROJ_DIR=. -# Path to requirements -REQ=requirements.txt -# Python executable -PYTHON=python -# Pip executable -PIP=pip - -# ------- -# Targets -# ------- - -all: help - -help: - @echo Following commands helps to operate the project. - @echo Make sure you are in project root directory and venv is active. - @echo ----------------------------- OPS------------------------------------- - @echo ' make build' - @echo ' Installs pip dependecies.' - @echo ' make doc' - @echo ' Builds documentation.' - @echo ' make serve' - @echo ' Starts build-in web server to preview doc.' - @echo '' - -# ensures virtual env is activated -virtual_env_set: -ifndef VIRTUAL_ENV - $(error Virtual environment $(VENV) is not active. Type `workon $(VENV)` to activate it) -endif - -# builds project from scratch -# installs or upgrades dependencies using pip -build: virtual_env_set $(REQ) - $(PIP) install --upgrade -r $(REQ) - -# starts build-in web server that previews the doc -serve: virtual_env_set mkdocs.yml - mkdocs serve - -# builds documentation -doc: virtual_env_set mkdocs.yml - mkdocs build --clean \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index 091f576d3..f17eefa7a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ jinja2>=3.1.3 Markdown<3.2 -mkdocs>=1.0 \ No newline at end of file +# mkdocs>=1.3.0 \ No newline at end of file