diff --git a/code/python/.gitignore b/code/python/.gitignore index a2d60ed..70d181a 100644 --- a/code/python/.gitignore +++ b/code/python/.gitignore @@ -28,8 +28,7 @@ !/docs !/docs/*/ -!/docs/*/Models/ -!/docs/**/*.md +!/docs/**/*.html !/tests !/tests/**/ diff --git a/code/python/docs/commands/Models/Command.md b/code/python/docs/commands/Models/Command.md deleted file mode 100644 index bf8f9e0..0000000 --- a/code/python/docs/commands/Models/Command.md +++ /dev/null @@ -1,9 +0,0 @@ -# Command -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/Models/CommandHirschberg.md b/code/python/docs/commands/Models/CommandHirschberg.md deleted file mode 100644 index 7f485dd..0000000 --- a/code/python/docs/commands/Models/CommandHirschberg.md +++ /dev/null @@ -1,12 +0,0 @@ -# CommandHirschberg -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] -**word1** | [**String**](string.md) | Word that gets placed vertically in algorithm. | [default to null] -**word2** | [**String**](string.md) | Word that gets placed horizontally in algorithm | [default to null] -**once** | [**Boolean**](boolean.md) | | [optional] [default to false] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/Models/CommandTarjan.md b/code/python/docs/commands/Models/CommandTarjan.md deleted file mode 100644 index 4ba26b3..0000000 --- a/code/python/docs/commands/Models/CommandTarjan.md +++ /dev/null @@ -1,11 +0,0 @@ -# CommandTarjan -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] -**nodes** | [**List**](anyOf<integer,number,string>.md) | | [default to null] -**edges** | [**List**](array.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/Models/CommandTsp.md b/code/python/docs/commands/Models/CommandTsp.md deleted file mode 100644 index ec644a1..0000000 --- a/code/python/docs/commands/Models/CommandTsp.md +++ /dev/null @@ -1,11 +0,0 @@ -# CommandTsp -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | [**EnumAlgorithmNames**](EnumAlgorithmNames.md) | | [default to null] -**dist** | [**List**](array.md) | | [default to null] -**optimise** | [**EnumTSPOptimise**](EnumTSPOptimise.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/Models/EnumAlgorithmNames.md b/code/python/docs/commands/Models/EnumAlgorithmNames.md deleted file mode 100644 index 7a4fb0c..0000000 --- a/code/python/docs/commands/Models/EnumAlgorithmNames.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnumAlgorithmNames -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/Models/EnumTSPOptimise.md b/code/python/docs/commands/Models/EnumTSPOptimise.md deleted file mode 100644 index 7a902a6..0000000 --- a/code/python/docs/commands/Models/EnumTSPOptimise.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnumTSPOptimise -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/commands/README.md b/code/python/docs/commands/README.md deleted file mode 100644 index 42fb44b..0000000 --- a/code/python/docs/commands/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Documentation for Schemata for command instructions - - -## Documentation for API Endpoints - -All URIs are relative to *http://.* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- - - - -## Documentation for Models - - - [Command](.//Models/Command.md) - - [CommandHirschberg](.//Models/CommandHirschberg.md) - - [CommandTarjan](.//Models/CommandTarjan.md) - - [CommandTsp](.//Models/CommandTsp.md) - - [EnumAlgorithmNames](.//Models/EnumAlgorithmNames.md) - - [EnumTSPOptimise](.//Models/EnumTSPOptimise.md) - - - -## Documentation for Authorization - -All endpoints do not require authorization. diff --git a/code/python/docs/commands/index.html b/code/python/docs/commands/index.html new file mode 100644 index 0000000..4d25e90 --- /dev/null +++ b/code/python/docs/commands/index.html @@ -0,0 +1,260 @@ + + + + Schemata for command instructions + + + +

Schemata for command instructions

+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
More information: https://openapi-generator.tech
+
Contact Info: team@openapitools.org
+
Version: 0.1.0
+
BasePath:
+
All rights reserved
+
http://apache.org/licenses/LICENSE-2.0.html
+

Access

+ +

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+ + +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    +
  1. Command -
    2. +
  2. CommandHirschberg -
    3. +
  3. CommandTarjan -
    4. +
  4. CommandTsp -
    5. +
  5. EnumAlgorithmNames -
    6. +
  6. EnumTSPOptimise -
    7. +
+ +
+

Command - Up

+
Instructions for command to call
+
+
name
EnumAlgorithmNames
+
+
+
+

CommandHirschberg - Up

+
Instructions for execution of Hirschberg-Algorithm
+
+
name
EnumAlgorithmNames
+
word1
String Word that gets placed vertically in algorithm.
+
word2
String Word that gets placed horizontally in algorithm
+
once (optional)
Boolean
+
+
+
+

CommandTarjan - Up

+
Instructions for execution of Tarjan-Algorithm
+
+
name
EnumAlgorithmNames
+
nodes
array[anyOf]
+
edges
array[array[anyOf]]
+
+
+
+

CommandTsp - Up

+
Instructions for execution of TSP-Algorithm
+
+
name
EnumAlgorithmNames
+
dist
array[array[BigDecimal]]
+
optimise
EnumTSPOptimise
+
+
+
+

EnumAlgorithmNames - Up

+
Enumeration of possible algorithm options.
+
+
+
+
+

EnumTSPOptimise - Up

+
Enumeration of optimisation options for TSP
+
+
+
+ + diff --git a/code/python/docs/config/Models/AppOptions.md b/code/python/docs/config/Models/AppOptions.md deleted file mode 100644 index 8015c77..0000000 --- a/code/python/docs/config/Models/AppOptions.md +++ /dev/null @@ -1,13 +0,0 @@ -# AppOptions -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**logMinuslevel** | [**EnumLogLevel**](EnumLogLevel.md) | | [default to null] -**verbose** | [**Boolean**](boolean.md) | Global setting for verbosity. | [optional] [default to false] -**tarjan** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] -**tsp** | [**AppOptions_tarjan**](AppOptions_tarjan.md) | | [default to null] -**hirschberg** | [**AppOptions_hirschberg**](AppOptions_hirschberg.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/AppOptionsHirschberg.md b/code/python/docs/config/Models/AppOptionsHirschberg.md deleted file mode 100644 index d53e887..0000000 --- a/code/python/docs/config/Models/AppOptionsHirschberg.md +++ /dev/null @@ -1,13 +0,0 @@ -# AppOptionsHirschberg -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**penalityMinusmismatch** | [**BigDecimal**](number.md) | | [default to 1] -**penalityMinusgap** | [**BigDecimal**](number.md) | | [default to 1] -**moveMinuspriorities** | [**AppOptions_hirschberg_move_priorities**](AppOptions_hirschberg_move_priorities.md) | | [default to null] -**verbose** | [**List**](EnumHirschbergVerbosity.md) | | [optional] [default to []] -**show** | [**List**](EnumHirschbergShow.md) | | [optional] [default to []] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.md b/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.md deleted file mode 100644 index 0fd6aa3..0000000 --- a/code/python/docs/config/Models/AppOptionsHirschbergMovePriorities.md +++ /dev/null @@ -1,11 +0,0 @@ -# AppOptionsHirschbergMovePriorities -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**diagonal** | [**Integer**](integer.md) | | [optional] [default to 0] -**horizontal** | [**Integer**](integer.md) | | [optional] [default to 1] -**vertical** | [**Integer**](integer.md) | | [optional] [default to 2] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/AppOptionsTarjan.md b/code/python/docs/config/Models/AppOptionsTarjan.md deleted file mode 100644 index 4793a79..0000000 --- a/code/python/docs/config/Models/AppOptionsTarjan.md +++ /dev/null @@ -1,9 +0,0 @@ -# AppOptionsTarjan -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**verbose** | [**Boolean**](boolean.md) | | [default to false] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/Config.md b/code/python/docs/config/Models/Config.md deleted file mode 100644 index 1cc470c..0000000 --- a/code/python/docs/config/Models/Config.md +++ /dev/null @@ -1,10 +0,0 @@ -# Config -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**info** | [**Info**](Info.md) | | [default to null] -**options** | [**AppOptions**](AppOptions.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/EnumHirschbergShow.md b/code/python/docs/config/Models/EnumHirschbergShow.md deleted file mode 100644 index 2aac6d3..0000000 --- a/code/python/docs/config/Models/EnumHirschbergShow.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnumHirschbergShow -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/EnumHirschbergVerbosity.md b/code/python/docs/config/Models/EnumHirschbergVerbosity.md deleted file mode 100644 index ca0e2c8..0000000 --- a/code/python/docs/config/Models/EnumHirschbergVerbosity.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnumHirschbergVerbosity -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/EnumLogLevel.md b/code/python/docs/config/Models/EnumLogLevel.md deleted file mode 100644 index 8f120a1..0000000 --- a/code/python/docs/config/Models/EnumLogLevel.md +++ /dev/null @@ -1,8 +0,0 @@ -# EnumLogLevel -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/Models/Info.md b/code/python/docs/config/Models/Info.md deleted file mode 100644 index 77e5486..0000000 --- a/code/python/docs/config/Models/Info.md +++ /dev/null @@ -1,11 +0,0 @@ -# Info -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**title** | [**String**](string.md) | | [default to null] -**description** | [**String**](string.md) | | [default to null] -**author** | [**String**](string.md) | | [default to null] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/code/python/docs/config/README.md b/code/python/docs/config/README.md deleted file mode 100644 index 19aa598..0000000 --- a/code/python/docs/config/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Documentation for Schemata for config models - - -## Documentation for API Endpoints - -All URIs are relative to *http://.* - -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- - - - -## Documentation for Models - - - [AppOptions](.//Models/AppOptions.md) - - [AppOptionsHirschberg](.//Models/AppOptionsHirschberg.md) - - [AppOptionsHirschbergMovePriorities](.//Models/AppOptionsHirschbergMovePriorities.md) - - [AppOptionsTarjan](.//Models/AppOptionsTarjan.md) - - [Config](.//Models/Config.md) - - [EnumHirschbergShow](.//Models/EnumHirschbergShow.md) - - [EnumHirschbergVerbosity](.//Models/EnumHirschbergVerbosity.md) - - [EnumLogLevel](.//Models/EnumLogLevel.md) - - [Info](.//Models/Info.md) - - - -## Documentation for Authorization - -All endpoints do not require authorization. diff --git a/code/python/docs/config/index.html b/code/python/docs/config/index.html new file mode 100644 index 0000000..4f448aa --- /dev/null +++ b/code/python/docs/config/index.html @@ -0,0 +1,289 @@ + + + + Schemata for config models + + + +

Schemata for config models

+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
More information: https://openapi-generator.tech
+
Contact Info: team@openapitools.org
+
Version: 0.1.0
+
BasePath:
+
All rights reserved
+
http://apache.org/licenses/LICENSE-2.0.html
+

Access

+ +

Methods

+ [ Jump to Models ] + +

Table of Contents

+
+ + +

Models

+ [ Jump to Methods ] + +

Table of Contents

+
    +
  1. AppOptions -
    2. +
  2. AppOptions_hirschberg -
    3. +
  3. AppOptions_hirschberg_move_priorities -
    4. +
  4. AppOptions_tarjan -
    5. +
  5. Config -
    6. +
  6. EnumHirschbergShow -
    7. +
  7. EnumHirschbergVerbosity -
    8. +
  8. EnumLogLevel -
    9. +
  9. Info -
    10. +
+ +
+

AppOptions - Up

+
Options pertaining to the rudimentary setup of the app.
+
+
logMinuslevel
EnumLogLevel
+
verbose (optional)
Boolean Global setting for verbosity.
+
tarjan
AppOptions_tarjan
+
tsp
AppOptions_tarjan
+
hirschberg
AppOptions_hirschberg
+
+
+
+

AppOptions_hirschberg - Up

+
+
+
penalityMinusmismatch
BigDecimal
+
penalityMinusgap
BigDecimal
+
moveMinuspriorities
AppOptions_hirschberg_move_priorities
+
verbose (optional)
array[EnumHirschbergVerbosity]
+
show (optional)
array[EnumHirschbergShow]
+
+
+
+

AppOptions_hirschberg_move_priorities - Up

+
+
+
diagonal (optional)
Integer
+
horizontal (optional)
Integer
+
vertical (optional)
Integer
+
+
+
+

AppOptions_tarjan - Up

+
+
+
verbose
Boolean
+
+
+
+

Config - Up

+
Data model for all parts of the configuration.
+
+
info
Info
+
options
AppOptions
+
+
+
+

EnumHirschbergShow - Up

+
Enumeration of verbosity options for Hirschberg
+
+
+
+
+

EnumHirschbergVerbosity - Up

+
Enumeration of verbosity options for Hirschberg
+
+
+
+
+

EnumLogLevel - Up

+
Enumeration of settings for log level.
+
+
+
+
+

Info - Up

+
Contains meta data about project.
+
+
title
String
+
description
String
+
author
String
+
+
+ + diff --git a/code/python/justfile b/code/python/justfile index 8dd7185..add1d05 100644 --- a/code/python/justfile +++ b/code/python/justfile @@ -62,7 +62,7 @@ _generate-models-documentation path name: @- just _create-folder-if-not-exists "docs/{{name}}" @- {{GEN_MODELS_DOCUMENTATION}} generate \ --input-spec {{path}}/{{name}}-schema.yaml \ - --generator-name markdown \ + --generator-name html \ --output "docs/{{name}}" @- just _clean-all-files .openapi-generator* @- just _clean-all-folders .openapi-generator*