Commit accbc9dd authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Refactored doc structure to contain operation.

parent a284dbf3
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
import os import os
import sys import sys
from recommonmark.transform import AutoStructify # from recommonmark.transform import AutoStructify
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
...@@ -48,16 +48,13 @@ extensions = [ ...@@ -48,16 +48,13 @@ extensions = [
'sphinxcontrib.httpdomain', 'sphinxcontrib.httpdomain',
'sphinxcontrib.autohttp.flask', 'sphinxcontrib.autohttp.flask',
'sphinxcontrib.autohttp.flaskqref', 'sphinxcontrib.autohttp.flaskqref',
'celery.contrib.sphinx' 'celery.contrib.sphinx',
'm2r'
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates'] templates_path = ['.templates']
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# #
...@@ -179,8 +176,8 @@ todo_include_todos = True ...@@ -179,8 +176,8 @@ todo_include_todos = True
# Enably sphinx specifc markdown features # Enably sphinx specifc markdown features
def setup(app): def setup(app):
app.add_stylesheet('css/custom.css') app.add_stylesheet('css/custom.css')
app.add_config_value('recommonmark_config', { # app.add_config_value('recommonmark_config', {
'enable_auto_doc_ref': True, # 'enable_auto_doc_ref': True,
'enable_eval_rst': True # 'enable_eval_rst': True
}, True) # }, True)
app.add_transform(AutoStructify) # app.add_transform(AutoStructify)
...@@ -11,4 +11,5 @@ and infrastructure with a simplyfied architecture and consolidated code base. ...@@ -11,4 +11,5 @@ and infrastructure with a simplyfied architecture and consolidated code base.
setup setup
dev_guidelines dev_guidelines
api api
ops
reference reference
Operating nomad
===============
.. mdinclude:: ../ops/README.md
.. mdinclude:: ../ops/containers/README.md
.. mdinclude:: ../ops/docker-compose/README.md
.. mdinclude:: ../ops/helm/README.md
\ No newline at end of file
# Reference Reference
=========
## nomad.config
```eval_rst
nomad.config
------------
.. automodule:: nomad.config .. automodule:: nomad.config
:members: :members:
```
## nomad.dependencies nomad.dependencies
```eval_rst ------------------
.. automodule:: nomad.dependencies .. automodule:: nomad.dependencies
```
## nomad.files nomad.files
```eval_rst -----------
.. automodule:: nomad.files .. automodule:: nomad.files
```
## nomad.parsing nomad.parsing
```eval_rst -------------
.. automodule:: nomad.parsing .. automodule:: nomad.parsing
```
## nomad.processing nomad.processing
```eval_rst ----------------
.. automodule:: nomad.processing .. automodule:: nomad.processing
```
## nomad.repo nomad.repo
```eval_rst ----------
.. automodule:: nomad.repo .. automodule:: nomad.repo
```
## nomad.user nomad.user
```eval_rst ----------
.. automodule:: nomad.coe_repo .. automodule:: nomad.coe_repo
```
## nomad.api nomad.api
```eval_rst ---------
.. automodule:: nomad.api .. automodule:: nomad.api
```
## nomad.utils nomad.utils
```eval_rst -----------
.. automodule:: nomad.utils .. automodule:: nomad.utils
``` \ No newline at end of file
\ No newline at end of file
## Overview
\ No newline at end of file
## Containers
\ No newline at end of file
## Single Node Deployment, Using Docker Compose
\ No newline at end of file
## Cluster Deployment, Using Kubernetes and Helm
\ No newline at end of file
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