From d29e733274f9bb44844772bffbd337288388ad9b Mon Sep 17 00:00:00 2001 From: Sven Sager Date: Tue, 20 Jun 2023 10:39:29 +0200 Subject: [PATCH] build: Add sphinx to build documentation Signed-off-by: Sven Sager --- .../Create_Documentation.xml | 19 +++++++++++++++++++ Makefile | 9 ++++++--- requirements.txt | 1 + 3 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 .idea/runConfigurations/Create_Documentation.xml diff --git a/.idea/runConfigurations/Create_Documentation.xml b/.idea/runConfigurations/Create_Documentation.xml new file mode 100644 index 0000000..54562b1 --- /dev/null +++ b/.idea/runConfigurations/Create_Documentation.xml @@ -0,0 +1,19 @@ + + + + + \ No newline at end of file diff --git a/Makefile b/Makefile index 51b9a60..04f00e3 100644 --- a/Makefile +++ b/Makefile @@ -9,7 +9,7 @@ PACKAGE = revpimodio2 SYSTEM_PYTHON = /usr/bin/python3 PYTHON = $(or $(wildcard venv/bin/python), $(SYSTEM_PYTHON)) -all: build +all: build docs .PHONY: all @@ -31,11 +31,14 @@ build: install: build $(PYTHON) -m pip install dist/$(PACKAGE)-*.whl -.PHONY: build install +docs: + $(PYTHON) -m sphinx.cmd.build -b html docs docs/_build/html + +.PHONY: build docs install ## Clean clean: - rm -rf build dist src/*.egg-info *.spec + rm -rf build docs/_build dist src/*.egg-info *.spec clean-all: clean rm -R venv diff --git a/requirements.txt b/requirements.txt index ed42133..9c8c3f3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ setuptools>=58.0.4 wheel +sphinx