Changed pyproject to configure docs

.github/workflows/sphinx-docs.yml

@@ -34,10 +34,16 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Build HTML
-        uses: ammaraskar/sphinx-action@master
+      - name: Install Python 
+        uses: actions/setup-python@v5 
         with: 
-          docs-folder: "docs/"
+          python-version: "3.12"
+      - name: Install Poetry 
+        uses: abatilo/actions-poetry@v2 
+      - name: Install the project dependencies
+        run: poetry install --only=docs
+      - name: Build HTML
+        run: cd docs && poetry run -- make html
       - name: Upload artifacts
         uses: actions/upload-pages-artifact@v3
         with:
@@ -51,10 +57,10 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      #- name: Checkout
-      #  uses: actions/checkout@v4
-      #- name: Setup Pages
-      #  uses: actions/configure-pages@v5
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

docs/make.bat

@@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
 set SOURCEDIR=source
-set BUILDDIR=build
+set BUILDDIR=_build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (

docs/source/conf.py

@@ -1,59 +1,3 @@
-import os
-import sys
+from sphinx_pyproject import SphinxConfig
 
-sys.path.insert(0, os.path.abspath("../../"))
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
-# -- Project information -----------------------------------------------------
-
-project = "dfttools"
-copyright = "2024, Lukas Hoermann, Dylan Morgan"
-author = "Lukas Hoermann, Dylan Morgan"
-
-
-# The full version, including alpha/beta/rc tags
-release = "00.00.01"
-
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon"]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "furo"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+config = SphinxConfig("../../pyproject.toml", globalns=globals(), style="poetry")

pyproject.toml

@@ -32,12 +32,34 @@ optional = true
 
 [tool.poetry.group.docs.dependencies]
 sphinx = "^7.4.7"
-furo = "^2024.7.18"
+piccolo-theme = "^0.23.0"
+sphinx-pyproject = "^0.3.0"
+myst-parser = "^3.0.1"
+sphinx-rtd-theme = "^2.0.0"
 
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.sphinx-pyproject]
+project = "dfttools"
+author = "Lukas Hoermann, Dylan Morgan"
+copyright = "2024, Lukas Hoermann, Dylan Morgan"
+# html_theme = "piccolo_theme"
+html_theme = "sphinx_rtd_theme"
+extensions = [
+  "sphinx.ext.autodoc",
+  "sphinx.ext.viewcode",
+  "sphinx.ext.napoleon",
+  "myst_parser",
+]
+templates_path = ["_templates",]
+html_static_path = ["_static",]
+exclude_patterns = [
+  "build", 
+  ".DS_Store",
+]
+
 [tool.pytest.ini_options]
 pythonpath = "dfttools"
 testpaths = ["tests"]