Refactored doc structure to contain operation.

docs/conf.py

@@ -13,7 +13,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
-from recommonmark.transform import AutoStructify
+# from recommonmark.transform import AutoStructify
 
 sys.path.insert(0, os.path.abspath('..'))
 
@@ -48,16 +48,13 @@ extensions = [
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.autohttp.flask',
     'sphinxcontrib.autohttp.flaskqref',
-    'celery.contrib.sphinx'
+    'celery.contrib.sphinx',
+    'm2r'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
 
-source_parsers = {
-    '.md': 'recommonmark.parser.CommonMarkParser',
-}
-
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -179,8 +176,8 @@ todo_include_todos = True
 # Enably sphinx specifc markdown features
 def setup(app):
     app.add_stylesheet('css/custom.css')
-    app.add_config_value('recommonmark_config', {
-        'enable_auto_doc_ref': True,
-        'enable_eval_rst': True
-    }, True)
-    app.add_transform(AutoStructify)
+    # app.add_config_value('recommonmark_config', {
+    #     'enable_auto_doc_ref': True,
+    #     'enable_eval_rst': True
+    # }, True)
+    # app.add_transform(AutoStructify)

docs/index.rst

@@ -11,4 +11,5 @@ and infrastructure with a simplyfied architecture and consolidated code base.
    setup
    dev_guidelines
    api
+   ops
    reference

docs/ops.rst

+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

docs/reference.md → docs/reference.rst

-# Reference
-
-## nomad.config
-```eval_rst
+Reference
+=========
 
+nomad.config
+------------
 .. automodule:: nomad.config
     :members:
-```
 
-## nomad.dependencies
-```eval_rst
+nomad.dependencies
+------------------
 .. automodule:: nomad.dependencies
-```
 
-## nomad.files
-```eval_rst
+nomad.files
+-----------
 .. automodule:: nomad.files
-```
 
-## nomad.parsing
-```eval_rst
+nomad.parsing
+-------------
 .. automodule:: nomad.parsing
-```
 
-## nomad.processing
-```eval_rst
+nomad.processing
+----------------
 .. automodule:: nomad.processing
-```
 
-## nomad.repo
-```eval_rst
+nomad.repo
+----------
 .. automodule:: nomad.repo
-```
 
-## nomad.user
-```eval_rst
+nomad.user
+----------
 .. automodule:: nomad.coe_repo
-```
 
-## nomad.api
-```eval_rst
+nomad.api
+---------
 .. automodule:: nomad.api
-```
 
-## nomad.utils
-```eval_rst
-.. automodule:: nomad.utils
-```
\ No newline at end of file
+nomad.utils
+-----------
+.. automodule:: nomad.utils
\ No newline at end of file

ops/README.md

+## Overview
\ No newline at end of file

ops/containers/README.md

+## Containers
\ No newline at end of file

ops/docker-compose/README.md

+## Single Node Deployment, Using Docker Compose
\ No newline at end of file

ops/helm/README.md

+## Cluster Deployment, Using Kubernetes and Helm
\ No newline at end of file

requirements.txt

@@ -12,7 +12,7 @@ python-logstash
 gitpython
 gunicorn
 structlog
-recommonmark
+m2r
 requests
 click
 sphinx