fix: add "other" menu entry, plus docs/tests

This commit is contained in:
Lance Edgar 2025-01-13 09:19:03 -06:00
parent ce54ca6bd6
commit c2f76f6c97
20 changed files with 546 additions and 15 deletions

20
docs/Makefile Normal file
View file

@ -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)

0
docs/_static/.keepme vendored Normal file
View file

View file

@ -0,0 +1,6 @@
``sideshow_corepos.batch.neworder``
===================================
.. automodule:: sideshow_corepos.batch.neworder
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos.batch``
==========================
.. automodule:: sideshow_corepos.batch
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos``
====================
.. automodule:: sideshow_corepos
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos.web.app``
============================
.. automodule:: sideshow_corepos.web.app
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos.web.menus``
==============================
.. automodule:: sideshow_corepos.web.menus
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos.web``
========================
.. automodule:: sideshow_corepos.web
:members:

View file

@ -0,0 +1,6 @@
``sideshow_corepos.web.views``
==============================
.. automodule:: sideshow_corepos.web.views
:members:

40
docs/conf.py Normal file
View file

@ -0,0 +1,40 @@
# 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
from importlib.metadata import version as get_version
project = 'Sideshow-COREPOS'
copyright = '2025, Lance Edgar'
author = 'Lance Edgar'
release = '0.1'
release = get_version('Sideshow-COREPOS')
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.todo',
]
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
intersphinx_mapping = {
'sideshow': ('https://rattailproject.org/docs/sideshow/', None),
'wuttjamaican': ('https://rattailproject.org/docs/wuttjamaican/', None),
}
# -- 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']

22
docs/index.rst Normal file
View file

@ -0,0 +1,22 @@
Sideshow-COREPOS
================
This is `Sideshow`_ with integration for `CORE-POS`_.
.. _Sideshow: https://pypi.org/project/Sideshow/
.. _CORE-POS: https://www.core-pos.com/
.. toctree::
:maxdepth: 1
:caption: API
api/sideshow_corepos
api/sideshow_corepos.batch
api/sideshow_corepos.batch.neworder
api/sideshow_corepos.web
api/sideshow_corepos.web.app
api/sideshow_corepos.web.menus
api/sideshow_corepos.web.views

35
docs/make.bat Normal file
View file

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
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