Revert "[wip] moved to sphinx documentation generation"

This reverts commit 0e6529f.

Makefile

@@ -8,7 +8,7 @@ LUALIBSAR  := v$(LUALIBSVER).zip
 LUALIBSURL := https://github.com/jtoppins/lua-libs/archive/$(LUALIBSAR)
 LUALIBSDIR := lua-libs-$(LUALIBSVER)
 
-.PHONY: check check-syntax tests build docs
+.PHONY: check check-syntax tests build
 check-syntax:
 	luacheck -q hooks scripts src tests
 
@@ -18,9 +18,6 @@ tests:
 
 check: check-syntax tests
 
-docs:
-	@${MAKE} -C docs html
-
 build:
 	mkdir -p "$(BUILDPATH)"/Mods/Tech/DCT/lua
 	cp -a "$(SRCPATH)"/src/dct/ "$(SRCPATH)"/src/dcthooks.lua \

docs/_config.yml

@@ -0,0 +1,14 @@
+title: Dynamic Campaign Tools
+tagline: Dynamic Campaigns for DCS
+description: Mission scripting framework for persistent Digital Combat Simulator (DCS) missions.
+remote_theme: pmarsceill/just-the-docs
+aux_links_new_tab: true
+github_link: "https://github.com/jtoppins/dct"
+discord_link: "https://discord.gg/6z8uERVW5Y"
+release_link: "https://github.com/jtoppins/dct/releases/latest"
+aux_links:
+        "DCT on GitHub":
+                - "https://github.com/jtoppins/dct"
+        "Contact Us":
+                - "https://discord.gg/6z8uERVW5Y"
+color_scheme: light

docs/_sass/color_schemes/dct.scss

@@ -0,0 +1,24 @@
+// remove borders
+$border: 0px none;
+
+// page body
+$body-background-color: $white;
+$table-background-color: $white;
+$code-background-color: $grey-lt-200;
+$body-text-color: $grey-dk-100;
+$body-heading-color: $grey-dk-300;
+$link-color: $blue-000;
+$btn-primary-color: $purple-100;
+
+// side navigation bar
+$sidebar-color: $grey-dk-000;
+$nav-child-link-color: $grey-dk-100;
+//$nav-list-item-height: $sp-6;
+//$nav-list-item-height-sm: $sp-8;
+$nav-list-expander-right: false;
+
+// search bar
+$search-background-color: $white;
+$feedback-color: darken($sidebar-color, 3%);
+$search-result-preview-color: $grey-dk-000;
+$search-results-width: $content-width - $nav-width;

docs/_sass/custom/custom.scss

@@ -0,0 +1,16 @@
+a:not([class]) {
+	background-image: none;
+
+	&:hover {
+		background-image: none;
+	}
+}
+
+blockquote {
+	color: gray;
+	margin-top: 10px;
+	margin-bottom: 10px;
+	margin-left: 50px;
+	padding-left: 15px;
+	border-left: 3px solid #ccc;
+}

docs/assets/css/just-the-docs-dct.scss

@@ -0,0 +1,3 @@
+---
+---
+{% include css/just-the-docs.scss.liquid color_scheme="dct" %}

docs/index.rst → docs/index.md

@@ -1,58 +1,55 @@
-DCS Dynamic Campaign Tools (DCT)
-================================
+---
+layout: default
+title: Home
+nav_order: 1
+permalink: /
+---
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   api/reference
+# Dynamic Campaign Tools (DCT)
 
 Mission scripting framework for persistent Digital Combat Simulator (DCS)
 missions.
 
 Provide a set of tools to allow mission designers to easily create scenarios
 for persistent dynamic campaigns within the DCS game world.
 
-**D**\ ynamic **C**\ ampaign **T**\ ools relies on content that can be built
-directly in the mission editor, these individuals need little to no programming
-skills to provide content to a DCT enabled mission.
+**D**ynamic **C**ampaign **T**ools relies on content that can be built
+directly in the mission editor, these individuals need little to no
+programming skills to provide content to a DCT enabled mission.
 
 Scenarios are created through a theater definition consisting of templates,
 created in the Mission Editor and configuration files. There is an initial
 learning curve but it is no more difficult than initially learning the DCS
 Mission Editor.
 
-Quick Start Guide
------------------
+## Quick Start Guide
 
 See our documentation [here](quick-start.md).
 
-Features and Capabilities
--------------------------
+## Features and Capabilities
 
 * **Mission Creation**
-
   - uses static templates for quicker asset creation
   - no large .miz to manage just place player slots
-  - theater and region organization to control spawning and placement
-  - settings to customize how you want your campaign to play
+  - theater and region organization to control spawning
+    and placement
+  - settings to customize how you want your campaign to
+    play
 
 * **Game Play**
-
   - Focus on more goal based gameplay vs. "air quake"
   - mission system used by AI and players
   - ticket system to track win/loss critera
   - Integrated Air Defense per faction
-  - Weapon point buy system for players to limit kinds and types of payloads
+  - Weapon point buy system for players to limit kinds and
+    types of payloads
   - Bomb blast effects enhancement and weapon impact system
 
 * **Technical**
-
   - Built for large scale scenarios
   - **Persistent campaign progress across server restarts**
 
-Contribution Guide
-------------------
+## Contribution Guide
 
 Contributions can be made with a github pull request but features and/or
 changes need to be discussed first. Code is licensed under LGPLv3 and
@@ -62,16 +59,8 @@ provide as much detail about the problem or feature as possible. New
 development is done in feature branches which are eventually merged into
 `master`, base your features and fixes off `master`.
 
-Contact Us
-----------
+## Contact Us
 
 You can join the VMFA-169 [discord]({{ site.discord_link }}) if you
 would like to discuss DCT topics. The channel is
 `#dynamic-campaign-tools-discussion`.
-
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`search`

src/dct.lua

@@ -1,8 +1,5 @@
 -- SPDX-License-Identifier: LGPL-3.0
 
---- Dynamic Campaign Tools.
---- @module dct
-
 local utils = require("libs.utils")
 
 local dct = {