Edits to the docs

.readthedocs.yaml

@@ -17,13 +17,17 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+ configuration: docs/source/conf.py
+ fail_on_warning: true
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
 #    - pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:
-   install:
-   - requirements: docs/requirements.txt
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -2,6 +2,11 @@
 
 Synthetic data for SQL databases
 
+## Documentation
+
+Welcome to `sqlsynthgen`.
+Our full documentation is available on <https://sqlsynthgen.readthedocs.io/>.
+
 ## Development
 
 ### Setup
@@ -10,6 +15,7 @@ Synthetic data for SQL databases
 
 1. Install [Poetry](https://python-poetry.org/docs/#installation).
 1. Create a Poetry environment and install dependencies with `poetry install`.
+   Use `poetry install --all-extras`, if you want to be able to build the docs.
 1. Activate a Poetry shell with `poetry shell`.
    We will assume that this shell is active for the remainder of the instructions.
 

docs/source/index.rst

@@ -3,10 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Draft sqlsynthgen's documentation
+sqlsynthgen's documentation
 =======================================
 
-**sqlsynthgen** is a etc
+**sqlsynthgen** is a package for making copies of relational databases and populating them with random data.
 
 .. note::
 
@@ -18,9 +18,9 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   changelog
    installation
-   modules
+   sqlsynthgen
+   changelog
 
 
 Indices and tables

docs/source/installation.rst

@@ -1,23 +1,17 @@
 Installation
 ============
 
-Get started
-------------
+End User
+--------
 
-To use sqlsynthgen, first install it using poetry:
+To use sqlsynthgen, first install it:
 
 .. code-block:: console
 
-   (<your_poetry_shell>) $ poetry add sqlsynthgen
+   $ pip install git+https://github.com/alan-turing-institute/sqlsynthgen.git
 
+and check that you can view the help message with:
 
-.. Test print integer function
-.. ---------------------------
-
-.. To test print integer function,
-.. you can use the ``sqlsynthgen.docs.print_int`` function:
-
-.. .. autofunction:: sqlsynthgen.docs.print_int
+.. code-block:: console
 
-.. The ``phone`` argument should be of type integer. Otherwise, :py:func:`sqlsynthgen.docs.print_int`
-.. will raise an exception.
+   $ sqlsynthgen --help

docs/source/sqlsynthgen.rst

@@ -1,5 +1,5 @@
-sqlsynthgen package
-===================
+The sqlsynthgen Package
+=======================
 
 Submodules
 ----------