diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 21 | ||||
| -rw-r--r-- | docs/functionality.rst | 32 | ||||
| -rw-r--r-- | docs/index.rst | 10 | ||||
| -rw-r--r-- | docs/installation.rst | 2 | ||||
| -rw-r--r-- | docs/introduction.rst | 5 | ||||
| -rw-r--r-- | docs/schemas.rst | 19 |
6 files changed, 0 insertions, 89 deletions
diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index bc23583..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,21 +0,0 @@ -import sphinx_rtd_theme - - -extensions = ['sphinx.ext.imgmath', - 'sphinx.ext.graphviz', - 'sphinx.ext.todo'] - -project = 'Hatter' -version = '0.0.1' -copyright = '2017, Božo Kopić' -master_doc = 'index' - -html_theme = 'sphinx_rtd_theme' -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -html_use_index = False -html_show_sourcelink = False -html_show_sphinx = False -html_sidebars = { - '**': ['globaltoc.html', 'relations.html']} - -todo_include_todos = True diff --git a/docs/functionality.rst b/docs/functionality.rst deleted file mode 100644 index 6943f14..0000000 --- a/docs/functionality.rst +++ /dev/null @@ -1,32 +0,0 @@ -Functionality -============= - -Hatter is CI tool with emphasis on simple workflow based on virtual machine -work executors. In contrast to most other CI tools, Hatter doesn't have -specialized executors that need to be installed on machines that execute -user defined commands. Each executor is generic VM with SSH daemon which -is used for file transfer and execution of user defined commands. Therefore, -Hatter is implemented as single daemon that orchestrates VMs lifecycle and -remote command execution. - - -Server ------- - -Hatter server daemon provides project execution orchestrator facility with -web-based administration interface. It is configured with single YAML -configuration defined by :ref:`JSON Schema <server-configuration>`. Single -server instance can support automation of multiple projects. - - -Project -------- - -Hatter project is represented by single git repository containing project -configuration file - `.hatter.yml`. Configuration file is defined by -:ref:`JSON Schema <project-configuration>`. This configuration can define -multiple execution environments with appropriate execution commands. - - -Execution environment ---------------------- diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 3ae48eb..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -Content -======= - -.. toctree:: - :includehidden: - - introduction - functionality - installation - schemas diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 11e4437..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,2 +0,0 @@ -Installation -============ diff --git a/docs/introduction.rst b/docs/introduction.rst deleted file mode 100644 index c435c88..0000000 --- a/docs/introduction.rst +++ /dev/null @@ -1,5 +0,0 @@ -Introduction
-============
-
-.. include:: ../README.rst
- :start-line: 2
diff --git a/docs/schemas.rst b/docs/schemas.rst deleted file mode 100644 index 4425ce3..0000000 --- a/docs/schemas.rst +++ /dev/null @@ -1,19 +0,0 @@ -JSON Schemas -============ - -.. _project-configuration: - -Project configuration ---------------------- - -.. literalinclude:: ../schemas_json/project.yaml - - -.. _server-configuration: - -Server configuration --------------------- - -.. literalinclude:: ../schemas_json/server.yaml - -.. literalinclude:: ../schemas_json/logging.yaml |
