Create sphinx-deploy.yml

Author: jimmac

.github/workflows/sphinx-deploy.yml

@@ -0,0 +1,18 @@
+name: Deploy Sphinx documentation to Pages
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

.gitlab-ci.yml

@@ -1,25 +1,3 @@
 ## Per-file attritubion
 
-Allan Day, Calum Benson, Adam Elman, Seth Nickell, Colin Robertson:
-
-* buttons.rst
-* check-boxes.rst:
-* dialogs.rst
-* keyboard-interaction.rst
-* menus.rst
-* radio-buttons.rst
-* sliders.rst
-* spin-buttons.rst
-* text-fields.rst
-* progress-bars.rst
-* tabs.rst
-* model-based.rst
-* drop-downs.rst
-
-Allan Day, William Jon McCann:
-
-* typography.rst
-
-Allan Day, Calum Benson, Adam Elman, Seth Nickell, Colin Robertson, Ekaterina Gerasimova:
-
-* writing-style.rst
+FIXME

00localbuild.sh

@@ -1,50 +1,3 @@
-# Human Interface Guidelines
-
-The GNOME Human Interface Guidelines are the primary source of UX design documentation for GNOME. Live at [developer.gnome.org/hig](https://developer.gnome.org/hig).
-
-This version replaces the previous version which was hosted as part of the [gnome-devel-docs](https://gitlab.gnome.org/GNOME/gnome-devel-docs/) module.
-
-The HIG is written in [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), generated using [Sphinx](https://www.sphinx-doc.org/en/master/index.html), and hosted using [GitLab pages](https://docs.gitlab.com/ee/user/project/pages/). It can be viewed online [here](https://developer.gnome.org/hig/).
-
-## Goals for the HIG
-
-Goals:
-
- - App designers and developers are the primary audiences
- - Document the most important and commond design patterns
- - Be easy to digest: don't be too long or verbose
- - Use examples and demos as much as possible 
-
-Non-goals:
-
- - Not a generic guide to UX design, and shouldn't try to fill in basic design knowledge, but should be accessible to those with relatively little design expertise
- - Don't document every design pattern or possible variation
- - Don't be prescriptive: allow designers to make their own choices, and give them the space to be creative
-
-## How to build and edit
-
-Sphinx can be used to build and preview the static html site locally, either with the browser or VS Code.
-
-### 1. Install dependencies
-
-On Fedora, run:
-
-```
-dnf install -y python3-sphinx python3-pip
-pip3 install --upgrade furo
-```
-
-### 2. Make changes
-
-VS Code is a good choice for this, as it is able to preview the source files as rendered HTML.
-
-### 3. Build
-
-Building the docs checks for errors, as well as producing local static HTML of the HIG website.
-
-To build, run `00localbuild.sh` from the project root. The build output can then be found in ``/build``.
-
-### 4. Deploy changes
-
-Changes to `main` branch are automatically deployed to the site using CI.
+# Granite.code Docs
 
+FIXME

COPYING.md

@@ -1,2 +1,3 @@
 sphinx==6.2.*
 furo
+sphinx-autobuild

Makefile

@@ -1,11 +1,15 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.13
 # by the following command:
 #
 #    pip-compile requirements.in
 #
 alabaster==0.7.16
     # via sphinx
+anyio==4.9.0
+    # via
+    #   starlette
+    #   watchfiles
 babel==2.14.0
     # via sphinx
 beautifulsoup4==4.12.3
@@ -14,12 +18,20 @@ certifi==2023.11.17
     # via requests
 charset-normalizer==3.3.2
     # via requests
+click==8.2.0
+    # via uvicorn
+colorama==0.4.6
+    # via sphinx-autobuild
 docutils==0.19
     # via sphinx
 furo==2024.1.29
     # via -r requirements.in
+h11==0.16.0
+    # via uvicorn
 idna==3.6
-    # via requests
+    # via
+    #   anyio
+    #   requests
 imagesize==1.4.1
     # via sphinx
 jinja2==3.1.3
@@ -34,6 +46,8 @@ pygments==2.17.2
     #   sphinx
 requests==2.31.0
     # via sphinx
+sniffio==1.3.1
+    # via anyio
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.5
@@ -42,7 +56,10 @@ sphinx==6.2.1
     # via
     #   -r requirements.in
     #   furo
+    #   sphinx-autobuild
     #   sphinx-basic-ng
+sphinx-autobuild==2024.10.3
+    # via -r requirements.in
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinxcontrib-applehelp==1.0.8
@@ -57,5 +74,13 @@ sphinxcontrib-qthelp==1.0.7
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.10
     # via sphinx
+starlette==0.46.2
+    # via sphinx-autobuild
 urllib3==2.1.0
     # via requests
+uvicorn==0.34.2
+    # via sphinx-autobuild
+watchfiles==1.0.5
+    # via sphinx-autobuild
+websockets==15.0.1
+    # via sphinx-autobuild