mirror of
https://github.com/Mailu/Mailu.git
synced 2024-12-12 10:45:38 +02:00
Use a template to replace the version tag
(cherry picked from commit 5831221c0e
)
This commit is contained in:
parent
ea9f3c0242
commit
2500a32234
4
docs/_templates/page.html
vendored
Normal file
4
docs/_templates/page.html
vendored
Normal file
@ -0,0 +1,4 @@
|
||||
{%- extends "layout.html" %}
|
||||
{% block body %}
|
||||
{{ body|replace("VERSION_TAG", version) }}
|
||||
{% endblock %}
|
@ -19,12 +19,12 @@ Docker Compose configuration is stored in a file named
|
||||
:download:`docker-compose.yml`. Additionally, Mailu
|
||||
relies on a :download:`.env` file for various settings. Download
|
||||
the proper template files from the git repository. To download the configuration
|
||||
for the ``{{ github_version }}`` branch, use:
|
||||
for the ``VERSION_TAG`` branch, use:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
wget https://mailu.io/{{ github_version }}/_downloads/docker-compose.yml
|
||||
wget https://mailu.io/{{ github_version }}/_downloads/.env
|
||||
wget https://mailu.io/VERSION_TAG/_downloads/docker-compose.yml
|
||||
wget https://mailu.io/VERSION_TAG/_downloads/.env
|
||||
|
||||
Then open the ``.env`` file to setup the mail server. Modify the ``ROOT`` setting
|
||||
to match your setup directory if different from ``/mailu``.
|
||||
|
19
docs/conf.py
19
docs/conf.py
@ -2,10 +2,7 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
|
||||
import os, sys, docutils
|
||||
|
||||
sys.path.append(os.path.dirname(__file__))
|
||||
extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'conf']
|
||||
extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode']
|
||||
templates_path = ['_templates']
|
||||
source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
@ -40,20 +37,6 @@ html_context = {
|
||||
}
|
||||
|
||||
|
||||
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
|
||||
if __name__ == "__main__":
|
||||
import os, sys, paramiko
|
||||
|
Loading…
Reference in New Issue
Block a user