docs first commit

. readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt

.gitignore

@@ -8,3 +8,4 @@ node_modules
 .idea/
 .coverage
 scratch*
+docs/_build/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,26 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "xlwings Server"
+copyright = "Zoomer Analytics GmbH"
+author = "Zoomer Analytics GmbH"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser"]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ["_static"]

docs/index.md

@@ -0,0 +1,8 @@
+# xlwings Server
+
+TODO
+
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents:

docs/requirements.txt

@@ -0,0 +1,4 @@
+furo
+sphinx
+sphinx-copybutton
+sphinx-design

requirements-dev-win.txt

@@ -2,6 +2,8 @@
 #    uv pip compile requirements-dev.in -o requirements-dev-win.txt --unsafe-package pywin32 --python-platform windows
 aiocache==0.12.2
     # via -r requirements.txt
+alabaster==1.0.0
+    # via sphinx
 annotated-types==0.7.0
     # via
     #   -r requirements.txt
@@ -14,8 +16,12 @@ anyio==4.4.0
     #   watchfiles
 azure-functions==1.20.0
     # via -r requirements.txt
+babel==2.16.0
+    # via sphinx
 beautifulsoup4==4.12.3
-    # via -r requirements-dev.in
+    # via
+    #   -r requirements-dev.in
+    #   furo
 bidict==0.23.1
     # via
     #   -r requirements.txt
@@ -25,12 +31,15 @@ certifi==2024.7.4
     #   -r requirements.txt
     #   httpcore
     #   httpx
+    #   requests
 cffi==1.17.0
     # via
     #   -r requirements.txt
     #   cryptography
 cfgv==3.4.0
     # via pre-commit
+charset-normalizer==3.3.2
+    # via requests
 click==8.1.7
     # via
     #   -r requirements.txt
@@ -39,6 +48,8 @@ colorama==0.4.6
     # via
     #   click
     #   pytest
+    #   sphinx
+    #   sphinx-autobuild
 croniter==3.0.3
     # via -r requirements.txt
 cryptography==43.0.0
@@ -47,10 +58,16 @@ cryptography==43.0.0
     #   joserfc
 distlib==0.3.8
     # via virtualenv
+docutils==0.21.2
+    # via
+    #   myst-parser
+    #   sphinx
 fastapi-slim==0.112.1
     # via -r requirements.txt
 filelock==3.15.4
     # via virtualenv
+furo==2024.8.6
+    # via -r requirements-dev.in
 gunicorn==23.0.0
     # via -r requirements.txt
 h11==0.14.0
@@ -76,20 +93,35 @@ idna==3.7
     #   -r requirements.txt
     #   anyio
     #   httpx
+    #   requests
+imagesize==1.4.1
+    # via sphinx
 iniconfig==2.0.0
     # via pytest
 jinja2==3.1.4
     # via
     #   -r requirements.txt
     #   jinja2-fragments
+    #   myst-parser
+    #   sphinx
 jinja2-fragments==1.5.0
     # via -r requirements.txt
 joserfc==1.0.0
     # via -r requirements.txt
+markdown-it-py==3.0.0
+    # via
+    #   mdit-py-plugins
+    #   myst-parser
 markupsafe==2.1.5
     # via
     #   -r requirements.txt
     #   jinja2
+mdit-py-plugins==0.4.1
+    # via myst-parser
+mdurl==0.1.2
+    # via markdown-it-py
+myst-parser==4.0.0
+    # via -r requirements-dev.in
 nodeenv==1.9.1
     # via pre-commit
 numpy==2.0.1
@@ -101,6 +133,7 @@ packaging==24.1
     #   -r requirements.txt
     #   gunicorn
     #   pytest
+    #   sphinx
 pandas==2.2.2
     # via -r requirements.txt
 platformdirs==4.2.2
@@ -124,6 +157,10 @@ pydantic-core==2.20.1
     #   pydantic
 pydantic-settings==2.4.0
     # via -r requirements.txt
+pygments==2.18.0
+    # via
+    #   furo
+    #   sphinx
 pytest==8.3.2
     # via
     #   -r requirements-dev.in
@@ -153,9 +190,13 @@ pytz==2024.1
     #   croniter
     #   pandas
 pyyaml==6.0.2
-    # via pre-commit
+    # via
+    #   myst-parser
+    #   pre-commit
 redis==5.0.8
     # via -r requirements.txt
+requests==2.32.3
+    # via sphinx
 simple-websocket==1.0.0
     # via
     #   -r requirements.txt
@@ -169,12 +210,38 @@ sniffio==1.3.1
     #   -r requirements.txt
     #   anyio
     #   httpx
+snowballstemmer==2.2.0
+    # via sphinx
 soupsieve==2.6
     # via beautifulsoup4
+sphinx==8.0.2
+    # via
+    #   -r requirements-dev.in
+    #   furo
+    #   myst-parser
+    #   sphinx-autobuild
+    #   sphinx-basic-ng
+sphinx-autobuild==2024.4.16
+    # via -r requirements-dev.in
+sphinx-basic-ng==1.0.0b2
+    # via furo
+sphinxcontrib-applehelp==2.0.0
+    # via sphinx
+sphinxcontrib-devhelp==2.0.0
+    # via sphinx
+sphinxcontrib-htmlhelp==2.1.0
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==2.0.0
+    # via sphinx
+sphinxcontrib-serializinghtml==2.0.0
+    # via sphinx
 starlette==0.38.2
     # via
     #   -r requirements.txt
     #   fastapi-slim
+    #   sphinx-autobuild
 typing-extensions==4.12.2
     # via
     #   -r requirements.txt
@@ -185,16 +252,24 @@ tzdata==2024.1
     # via
     #   -r requirements.txt
     #   pandas
-uv==0.2.37
+urllib3==2.2.2
+    # via requests
+uv==0.3.0
     # via -r requirements-dev.in
 uvicorn==0.30.6
-    # via -r requirements.txt
+    # via
+    #   -r requirements.txt
+    #   sphinx-autobuild
 uvloop==0.20.0
     # via -r requirements.txt
 virtualenv==20.26.3
     # via pre-commit
 watchfiles==0.23.0
-    # via -r requirements-dev.in
+    # via
+    #   -r requirements-dev.in
+    #   sphinx-autobuild
+websockets==13.0
+    # via sphinx-autobuild
 wsproto==1.2.0
     # via
     #   -r requirements.txt

requirements-dev.in

@@ -8,8 +8,12 @@
 
 -r requirements.txt  # Don't delete this line
 beautifulsoup4
+furo
+myst-parser
 pre-commit
 pytest
 pytest-mock
+sphinx
+sphinx-autobuild
 uv
 watchfiles