From 7f371ff2d0bb969a1eae891eec6037bed36f0c3a Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Sat, 8 Jan 2022 19:52:39 -0600 Subject: [PATCH] Doc tweaks --- docs/index.rst | 5 ++--- docs/install/integration.rst | 2 +- docs/install/manual.rst | 2 +- docs/quickstart.rst | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 530e911..7bb1910 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ Theo, the order system ====================== -First of all, welcome to Theo and/or Rattail in general. +First of all, welcome to Theo and/or the Rattail Project in general. Theo offers various features with an aim to be "the order system" for an organization (or at least as much of one as is needed). It is @@ -23,8 +23,7 @@ Please see `https://rattailproject.org/docs/theo/ document. .. toctree:: - :maxdepth: 3 - :caption: Contents: + :maxdepth: 1 quickstart features diff --git a/docs/install/integration.rst b/docs/install/integration.rst index bedcb28..9488786 100644 --- a/docs/install/integration.rst +++ b/docs/install/integration.rst @@ -69,7 +69,7 @@ Most integrations will require some extra tables installed to your database. But installing them is no different than any other migration, i.e. just run the normal commands: -.. code-block::sh +.. code-block:: sh cd /srv/envs/theo bin/alembic -c app/rattail.conf upgrade heads diff --git a/docs/install/manual.rst b/docs/install/manual.rst index d13698a..2cb3dc2 100644 --- a/docs/install/manual.rst +++ b/docs/install/manual.rst @@ -26,7 +26,7 @@ it just needs to be accessible over the network by Theo. These docs assume Linux for the Theo machine, but it is believed that with minimal tweaks this should work on Windows as well. However it should be noted that Windows does pose some issues, and this all -likely will work "better" on Linux at this point. Windows "support" +likely will work "better" on Linux at this point. Windows support should be considered experimental. (In any case PostgreSQL can run on a Windows machine if you prefer diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 0183e3e..ddc0da0 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -5,7 +5,7 @@ Quick Start =========== This should get you up and running in minutes, with a "bare" Theo setup, -meaning no POS integration. +meaning no POS integration. (You can add that later if desired.) Clone the source code for Theo wherever you like, e.g. ``~/src/theo``::