revpi/revpimodio2
1
0
Fork 0
mirror of https://github.com/naruxde/revpimodio2.git synced 2025-11-08 13:53:53 +01:00
Code Issues Packages Releases Wiki Activity

build: Add sphinx to build documentation

Browse Source 
Signed-off-by: Sven Sager <akira@narux.de>
This commit is contained in:
Sven Sager
2023-06-20 10:39:29 +02:00
parent 6f4777317e
commit d29e733274
3 changed files with 26 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
.idea/runConfigurations/Create_Documentation.xml generated Normal file
View File

@@ -0,0 +1,19 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Create Documentation" type="docs" factoryName="Sphinx task">
<module name="revpimodio2" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="PARENT_ENVS" value="true" />
<option name="SDK_HOME" value="" />
<option name="WORKING_DIRECTORY" value="" />
<option name="IS_MODULE_SDK" value="true" />
<option name="ADD_CONTENT_ROOTS" value="true" />
<option name="ADD_SOURCE_ROOTS" value="true" />
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
<option name="docutils_input_file" value="$PROJECT_DIR$/docs" />
<option name="docutils_output_file" value="$PROJECT_DIR$/docs/_build/html" />
<option name="docutils_params" value="" />
<option name="docutils_task" value="html" />
<option name="docutils_open_in_browser" value="false" />
<method v="2" />
</configuration>
</component>

9
Makefile
View File

@@ -9,7 +9,7 @@ PACKAGE = revpimodio2
SYSTEM_PYTHON = /usr/bin/python3 SYSTEM_PYTHON = /usr/bin/python3
PYTHON = $(or $(wildcard venv/bin/python), $(SYSTEM_PYTHON)) PYTHON = $(or $(wildcard venv/bin/python), $(SYSTEM_PYTHON))
all: build all: build docs
.PHONY: all .PHONY: all
@@ -31,11 +31,14 @@ build:
install: build install: build
$(PYTHON) -m pip install dist/$(PACKAGE)-*.whl $(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
clean: clean:
rm -rf build dist src/*.egg-info *.spec rm -rf build docs/_build dist src/*.egg-info *.spec
clean-all: clean clean-all: clean
rm -R venv rm -R venv

1
requirements.txt
View File

@@ -1,2 +1,3 @@
setuptools>=58.0.4 setuptools>=58.0.4
wheel wheel
sphinx