add docs

Author: Owen

.github/workflows/publish.yml

@@ -13,8 +13,8 @@ jobs:
       matrix:
         os: [
           ubuntu-20.04,
-          # macos-11,
-          # macos-12,
+          macos-11,
+          macos-12,
           # windows-2019,
           # windows-2022,
         ]

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     = docs
+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)

README.md

@@ -1 +1,5 @@
-# pysicgl
+# pysicgl
+
+pysicgl is a Python C extension interface for the [sicgl](https://github.com/oclyke-dev/sicgl) graphics library.
+
+both projects are young and would benefit from community involvement.

docs/concepts.rst

@@ -0,0 +1,41 @@
+.. _concepts:
+
+concepts
+----------------
+
+pysicgl is a Python interface to `sicgl<https://github.com/oclyke-dev/sicgl>`_
+-- underlying design choices stem from that project. Briefly these goals include:
+* speed over memory footprint
+* hardware agnostic
+* straightforward configuration
+* test coverage
+
+assumptions
+-------------------
+* rectangular interfaces and screens 
+
+workflow
+----------------
+
+sicgl uses an "interface" as the target of any graphic operation. this interface 
+defines a rectangular region as well as underlying memory for each pixel in that
+region.
+
+* define interface screen and allocate memory
+* create the interface
+* apply graphics operations on this memory via the interface
+
+drawing domains
+---------------
+
+drawing operations can exist in one of three coordinate spaces:
+* interface: relative to the interface itself
+* screen: relative to an independent screen definition
+* global: relative to the global coordinate spaces
+
+these domains are indicated in each of the available drawing functions. e.g.
+* interface_line draws a line in interface coordinates, clippped to interface boundaries
+* global_line draws a line in global coordinates, clipped to interface boundaries
+* screen_line draws a line in screen-relative coordinates, clipped to both the screen and interface boundaries
+
+all of the above functions draw the line to the parent interface.

docs/conf.py

@@ -0,0 +1,28 @@
+# 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 = 'pysicgl'
+copyright = '2023, oclyke'
+author = 'oclyke'
+release = 'latest'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,22 @@
+.. pysicgl documentation master file, created by
+   sphinx-quickstart on Thu Jan 19 12:28:50 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pysicgl's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   concepts
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

requirements.dev.txt

@@ -1,2 +1,3 @@
 black >= 22.12.0, < 23.0.0
 pytest >= 7.2.1, < 8.0.0
+sphinx >= 6.1.3, < 7.0.0