Update documentation

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Jan Dittberner
+Copyright (c) 2015-2020 Jan Dittberner
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.rst

@@ -10,4 +10,4 @@ customer management at `Jan Dittberner IT-Consulting & -Solutions
 
 Read the :doc:`Installation instructions <install>` to get started locally.
 
-The project page for gvafile is at http://dev.gnuviech-server.de/gvaweb.
+The project page for gvafile is at http://git.dittberner.info/gnuviech/gvaweb.

docs/changelog.rst

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+* :release:`0.1.5 <2020-02-29>`
+* :bug:`-` fix path to systemctl
+* :bug:`-` reduce template for nginx vhosts to the bare minimum to use
+  letsencrypt’s certbot
+
+* :release:`0.1.4 <2019-09-07>`
+* :bug:`-` remove handling of php-fpm reloads
+* :bug:`-` use systemctl to reload nginx
+
+* :release:`0.1.3 <2019-09-07>`
+* :bug:`-` fix handling of manually removed configuration files
+
 * :release:`0.1.2 <2019-06-30>`
 * :bug:`5` ignore missing site configuration when disabling sites
 * :bug:`-` add listen directive to enable IPv6

docs/conf.py

@@ -53,7 +53,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'gvaweb'
-copyright = u'2015-2019, Jan Dittberner'
+copyright = u'2015-2020, Jan Dittberner'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -62,7 +62,7 @@ copyright = u'2015-2019, Jan Dittberner'
 # The short X.Y version.
 version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1.2'
+release = '0.1.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/install.rst

@@ -7,64 +7,17 @@ Install
 Working Environment
 ===================
 
-You have several options in setting up your working environment.  We recommend
-using virtualenv to separate the dependencies of your project from your
-system's python environment.  If on Linux or Mac OS X, you can also use
-virtualenvwrapper to help manage multiple virtualenvs across different
-projects.
+To get a running work environment use `pipenv`_.
 
-.. index:: virtualenv
+.. _pipenv: https://pipenv.kennethreitz.org/en/latest/
 
-Virtualenv Only
----------------
-
-First, make sure you are using `virtualenv`_. Once that's installed, create
-your virtualenv:
+To get started install `pip` and `pipenv` and use `pipenv install --dev`:
 
 .. code-block:: sh
 
-    $ virtualenv --distribute gvaweb
-
-.. _virtualenv: https://virtualenv.pypa.io/en/latest/
-
-You will also need to ensure that the virtualenv has the project directory
-added to the path.
-
-.. index:: virtualenvwrapper
-
-Virtualenv with virtualenvwrapper
-------------------------------------
-
-In Linux and Mac OSX, you can install `virtualenvwrapper
-<http://virtualenvwrapper.readthedocs.org/en/latest/>`_, which will take care
-of managing your virtual environments and adding the project path to the
-`site-directory` for you:
-
-.. code-block:: sh
-
-    $ mkdir gvaweb
-    $ mkvirtualenv -a gvaweb gvaweb-dev
-    $ cd gvaweb && add2virtualenv `pwd`
-
-
-.. index:: pip, requirements, dependencies
-
-Installation of Dependencies
-=============================
-
-Depending on where you are installing dependencies:
-
-In development:
-
-.. code-block:: sh
-
-    $ pip install -r requirements/local.txt
-
-For production:
-
-.. code-block:: sh
-
-    $ pip install -r requirements.txt
+   $ apt install python3-pip
+   $ python3 -m pip install --user -U pipenv
+   $ pipenv install --dev
 
 .. index:: celery, worker, file queue
 
@@ -78,6 +31,6 @@ into the gvaweb directory and run the celery worker with:
 .. code-block:: sh
 
     $ cd gvaweb
-    $ celery -A gvaweb worker -Q web -l info
+    $ pipenv run celery -A gvaweb worker -Q web -l info
 
 .. _Celery: http://www.celeryproject.org/