Adding doc page (#121)

* First version of doc site (need to prune a ton of content written with AI)

* Remove CLAUDE.md

* Removed a bunch of extra pages generated by AI

* Bringing docs from old site

* Added config examples

* Adding site workflow and removing more old files.

Author: marcosfrenkel

.github/workflows/sphinx-docs.yml

@@ -0,0 +1,41 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    - name: Set up conda
+      uses: conda-incubator/setup-miniconda@v3
+      with:
+        auto-activate-base: true
+        activate-environment: instrumentserver-docs
+        environment-file: environment-docs.yml
+
+    - name: Install instrumentserver package
+      shell: bash -l {0}
+      run: pip install -e .
+
+    - name: Build HTML
+      shell: bash -l {0}
+      run: cd docs && make html
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/master'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

.gitignore

@@ -62,7 +62,11 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-doc/_build/
+docs/build/
+# These files are generated automatically by autosummary
+docs/**/*.rst
+docs/**/generated
+site/
 
 # PyBuilder
 target/

CLAUDE.md

@@ -0,0 +1,33 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+PAPER         ?=
+BUILDDIR      ?= build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the actual 'sphinx-build' executable. Alternatively you can add a directory to the PATH environment variable so that the '$(SPHINXBUILD)' executable is found.)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the output directory and doctrees with the other builders
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help Makefile
+
+# Put it first so that "make" without argument is still useful for quick reference.
+help:
+	@$(SPHINXBUILD) -M help $(ALLSPHINXOPTS)
+
+.PHONY: help Makefile
+%: Makefile
+	@$(SPHINXBUILD) -M $@ $(ALLSPHINXOPTS) $(BUILDDIR)
+
+clean:
+	rm -rf $(BUILDDIR)
+	rm -rf api/generated