Merge branch '1.5'

master
kaiyou 7 years ago
commit 8c71037d3d

@ -19,17 +19,17 @@ Docker Compose configuration is stored in a file named
:download:`docker-compose.yml`. Additionally, Mailu :download:`docker-compose.yml`. Additionally, Mailu
relies on a :download:`.env` file for various settings. Download relies on a :download:`.env` file for various settings. Download
the proper template files from the git repository. To download the configuration the proper template files from the git repository. To download the configuration
for the "|version|" branch, use: for the ``{{ github_version }}`` branch, use:
.. parsed-literal:: .. code-block:: bash
wget https://mailu.io/|version|/_downloads/docker-compose.yml wget https://mailu.io/{{ github_version }}/_downloads/docker-compose.yml
wget https://mailu.io/|version|/_downloads/.env wget https://mailu.io/{{ github_version }}/_downloads/.env
Then open the ``.env`` file to setup the mail server. Modify the ``ROOT`` setting Then open the ``.env`` file to setup the mail server. Modify the ``ROOT`` setting
to match your setup directory if different from ``/mailu``. to match your setup directory if different from ``/mailu``.
Mdify the ``VERSION`` configuration in the ``.env`` file to reflect the version you picked.. Mdify the ``VERSION`` configuration in the ``.env`` file to reflect the version you picked.
Set the common configuration values Set the common configuration values
----------------------------------- -----------------------------------

@ -2,8 +2,10 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
extensions = ['sphinx.ext.imgmath', import os, sys, docutils
'sphinx.ext.viewcode']
sys.path.append(os.path.dirname(__file__))
extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'conf']
templates_path = ['_templates'] templates_path = ['_templates']
source_suffix = '.rst' source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
@ -37,6 +39,21 @@ html_context = {
'conf_py_path': '/docs/' 'conf_py_path': '/docs/'
} }
def setup(app):
""" The conf itself is an extension for parsing rst.
"""
def rstjinja(app, docname, source):
""" Render our pages as a jinja template for fancy templating.
"""
if app.builder.format != 'html':
return
source[0] = app.builder.templates.render_string(
source[0], app.config.html_context)
app.connect("source-read", rstjinja)
# Upload function when the script is called directly # Upload function when the script is called directly
if __name__ == "__main__": if __name__ == "__main__":
import os, sys, paramiko import os, sys, paramiko

@ -26,7 +26,7 @@ for trust in a specific branch of the project, we can switch to a shared
repository and add a couple of trusted committers. repository and add a couple of trusted committers.
Commits Commits
`````` ```````
This is a community project, thus commits should be readable enough for any of This is a community project, thus commits should be readable enough for any of
the contributors to guess the content by simply reading the comment or find a the contributors to guess the content by simply reading the comment or find a

@ -8,7 +8,7 @@ Mailu uses Babel for internationalization and localization. Before any
of your work is merged, you must make sure that your strings are internationalized of your work is merged, you must make sure that your strings are internationalized
using Babel. using Babel.
If you used ``_``, ``{% trans %}`` and other Babel syntaxes in your code, run the If you used ``_``, ``trans`` blocks and other Babel syntaxes in your code, run the
following command to update the POT file: following command to update the POT file:
.. code-block:: bash .. code-block:: bash

Loading…
Cancel
Save