Documentation

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

docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a9c883f4d1b3d239cf9a08fd9c1c1ee0
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,59 @@
+.. Frontmatter creator documentation master file, created by
+   sphinx-quickstart on Thu Apr  2 08:21:24 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+=================================================
+ Welcome to Frontmatter creator's documentation!
+=================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+Code Generator
+==============
+
+Generates LaTeX code for informative frontmatters. These will be
+attached to the chapter PDFs of EOA publications we offer for
+download.
+
+With the output comes also a script file which will replace the
+original files on the server.
+
+Copy the ``generated_files`` folder to the server and from there run the
+script.
+
+Dependencies
+------------
+
+- texlive-xetex
+- python3-pypdf2
+
+Config file
+-----------
+
+The program requires a config file that stores some paths and, if a
+postgres database is used, the credentials for it. If several
+publication platforms are used, simply create different config files
+for each instance.
+
+It should contain at least the following fields::
+
+  [server]
+  media_dir:
+  production_url:
+
+When using SQLite, you can specify the database file like this::
+
+  [sqlite]
+  database_file:
+
+Insert the postgres database credentials like this::
+
+  [postgres]
+  database_name:
+  user:
+  host:
+  password: ""