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

First structure of the documentation

parent 9c60ef5f
docs/build/
\ No newline at end of file
img[alt=logo] {
width: 200px;
}
\ No newline at end of file
......@@ -31,6 +31,7 @@ release = '0.0.1'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark'
]
# Add any paths that contain templates here, relative to this directory.
......@@ -53,6 +54,18 @@ html_theme = 'alabaster'
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# custom stylesheet is _static/css/custom.css
html_css_files = [
'css/custom.css'
]
# Based on https://github.com/readthedocs/readthedocs.org/issues/2569
master_doc = 'index'
# https://www.sphinx-doc.org/en/master/usage/markdown.html
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}
![logo](images/logo.png)
# An integrated energy systems modelling platform | [nexus-e.org](https://nexus-e.org/)
### **Contents**
- [Setup](#setup)
- [Get permissions](#get-permissions)
- [Local setup](#local-setup)
- [Euler setup](#euler-setup)
- [Euler instructions](#euler-instructions)
- [Nexus-e repository instructions](#nexus-e-repository-instructions)
### **Setup**
#### Get permissions
#### Local setup
1. Get the codes
1. Prepare software & license
1. Connect with the input database
1. Run Nexus-e
#### Euler setup
1. Join the usergroup
1. Get the codes
1. Prepare software & license
1. Connect with the input database
1. Run Nexus-e
### **Euler instructions**
### **Nexus-e repository instructions**
.. Nexus-e documentation master file, created by
sphinx-quickstart on Wed Sep 23 11:09:50 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Nexus-e's documentation!!!!
=======================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
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