Add docs, for sake of quick start guide

This commit is contained in:
Lance Edgar 2021-01-27 17:30:55 -06:00
parent f6cf02bcaf
commit 93fad98008
6 changed files with 162 additions and 0 deletions

1
.gitignore vendored
View file

@ -1,5 +1,6 @@
tailbone_theo.egg-info/
dev/settings.ini
docs/_build/
machines/theo-server/.vagrant/
machines/theo-server/fabenv.py
machines/theo-server/fabric.yaml

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)

55
docs/conf.py Normal file
View file

@ -0,0 +1,55 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Theo'
copyright = '2021, Lance Edgar'
author = 'Lance Edgar'
# The full version, including alpha/beta/rc tags
release = '0.1.x'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

20
docs/index.rst Normal file
View file

@ -0,0 +1,20 @@
Theo, the order system
======================
For now the main focus is on the :doc:`quickstart` guide. Other docs can wait
until that is good enough.
.. toctree::
:maxdepth: 2
:caption: Contents:
quickstart
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

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
if "%1" == "" goto help
%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.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

31
docs/quickstart.rst Normal file
View file

@ -0,0 +1,31 @@
.. highlight:: sh
Quick Start
===========
This should get you up and running in minutes, with a "bare" Theo setup,
meaning no POS integration.
Clone the source code for Theo wherever you like, e.g. ``~/src/theo``::
mkdir -p ~/src
cd ~/src
git clone https://kallithea.rattailproject.org/rattail-project/theo
Your local PostgreSQL service should be available, and user (named ``rattail``)
and DB (named ``theo``) created::
sudo apt install postgresql
sudo -u postgres createuser -P rattail
sudo -u postgres createdb -O rattail theo
Make and activate a virtual environment, e.g. ``/srv/envs/theo``::
mkdir -p /srv/envs
python -m venv /srv/envs/theo
source /srv/envs/theo/bin/activate
With the virtual environment active, run the development bootstrap script::
python ~/src/theo/dev/bootstrap.py