Merge pull request #32 from IanVzs/dev

😯 * 3 delete all py3.8
xmsociety · Sep 26, 2024 · e0c37aa · e0c37aa
2 parents 761deba + 7eb44e1
commit e0c37aa
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 122 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: "${{ matrix.os }}"
     strategy:
       matrix:
-        python-version: [3.8, 3.9]
+        python-version: ["3.9", "3.10"]
         os: [windows-latest, ubuntu-latest, macos-latest]
     env:
       OS: ${{ matrix.os }}
@@ -51,7 +51,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.12
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip poetry
@@ -78,7 +78,7 @@ jobs:
           poetry config virtualenvs.create false --local
           poetry install
       - name: Build docs
-        run: cd docs && make html
+        run: pip install sphinx && pip install myst_parser && cd docs && make html
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:

diff --git a/docs/Makefile b/docs/Makefile
@@ -8,13 +8,21 @@ SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = _build
 
+# Function to check if sphinx-build exists
+check_sphinx:
+	@command -v $(SPHINXBUILD) >/dev/null 2>&1 || { \
+		echo "Error: $(SPHINXBUILD) not found."; \
+		echo "You can check your Python installation with: whereis python"; \
+		exit 1; \
+	}
+
 # Put it first so that "make" without argument is like "make help".
-help:
+help: check_sphinx
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile check_sphinx
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile check_sphinx
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/guide.md b/docs/source/guide.md
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -1,17 +1,19 @@
 # DesktopTools
-python http file server
+python desktop tools
 
 ## Install & Run
 ### Source
 ```bash
-# TODO
+git clone [email protected]:xmsociety/DesktopTools.git
+cd DesktopTools
+pip install .
 ```
 
 ### Pip
 Make sure you have pip installed.
 
 ```bash
-pip install DesktopTools
+pip install DesktopTools[ui]
 ```
 #### Local
 ```

diff --git a/docs/source/server.md b/docs/source/server.md