Commit c812a6c0 authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Added emoji, AutoStructify, and "get permissions" section

parent 3057e246
......@@ -7,3 +7,4 @@ sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
sphinxcontrib-websupport==1.2.0
sphinxemoji==0.1.6
\ No newline at end of file
......@@ -14,6 +14,10 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# To enable AutoStructify: https://github.com/readthedocs/recommonmark#autostructify
import recommonmark
from recommonmark.transform import AutoStructify
# -- Project information -----------------------------------------------------
......@@ -31,7 +35,8 @@ release = '0.0.1'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark'
'recommonmark',
'sphinxemoji.sphinxemoji',
]
# Add any paths that contain templates here, relative to this directory.
......@@ -69,3 +74,11 @@ source_suffix = {
'.md': 'markdown',
}
# To enable AutoStructify: https://github.com/readthedocs/recommonmark#autostructify
def setup(app):
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
app.add_transform(AutoStructify)
......@@ -2,7 +2,7 @@
:width: 200px
An integrated energy systems modelling platform | `nexus-e.org <http://nexus-e.org/>`_
=======================================
========================================================================================
.. toctree::
:maxdepth: 2
......
......@@ -6,6 +6,30 @@
#### Get permissions
Before setting up, you need permissions to access the codes and the input database. Email the following people to ask for the corresponding permissions.
```eval_rst
|:warning:| **NOTE**: Currently, the codes are only accessble with an ETH account.
```
- Xuejiao Han (xuhan@eeh.ee.ethz.ch):
- permission for the **DistIv** repository
- access to the **PSL server** for the database (server name: itet-psl-s02)
- Jared Garrison (garrison@fen.ethz.ch):
- permissions for the **eMark** repository
- permissions for the **Shared** repository,
- username and password for the **database**
- Blazhe Gjorgiev (gblazhe@ethz.ch):
- permission for the **Cascades** repository
- permission for the **Run_Nexuse** repository
- Elena Raycheva (elena.raycheva@esc.ethz.ch):
- permission for the **CentIv** repository
- Florian Landis (landisf@ethz.ch):
- permission for the **GemEl** repository
- Xuqian Yan (xuqian.yan@esc.ethz.ch):
- permission for the overarching **Nexus-e** repository
#### Local setup
1. Get the codes
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment