self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-11-27 22:18:22 +02:00
Code Issues Releases Activity

Use a custom role for including github_version

Browse Source
This commit is contained in:
kaiyou
2017-11-06 12:10:54 +01:00
parent 8b9d9ef86d
commit 30a1657155
2 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/compose/setup.rst
View File

@@ -19,12 +19,12 @@ 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 "|github_version|" branch, use: for the ":var:`github_version`" branch, use:
.. parsed-literal:: .. parsed-literal::
wget https://mailu.io/|github_version|/_downloads/docker-compose.yml wget https://mailu.io/:var:`github_version`/_downloads/docker-compose.yml
wget https://mailu.io/|github_version|/_downloads/.env wget https://mailu.io/:var:`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``.

16
docs/conf.py
View File

@@ -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,16 @@ html_context = {
'conf_py_path': '/docs/' 'conf_py_path': '/docs/'
} }
def setup(app):
""" The configuration acts as an extension itself.
"""
def var_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
return [docutils.nodes.Text(html_context.get(text, ""))], []
app.add_role("var", var_role)
# 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