Issue #142 various doc (building) tweaks

.github/workflows/docs2ghpages.yml

@@ -4,6 +4,9 @@ name: Build docs and push to GitHub Pages
 on:
   push:
     branches: [ master ]
+    paths:
+      - 'docs/**'
+      - CHANGELOG.md
 
 jobs:
   build:

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 The format is roughly based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+<!-- start changelog -->
+
 ## 0.35.0
 
 - Start with `openeo-aggregator` docs, hosted with GitHub Pages at https://open-eo.github.io/openeo-aggregator/ ([#142](https://github.com/Open-EO/openeo-aggregator/issues/142))
@@ -338,3 +340,6 @@ The format is roughly based on [Keep a Changelog](https://keepachangelog.com/en/
 ### Fixed
 
 - Skip failing back-ends when merging `/jobs` listings (EP-4014)
+
+
+<!-- end changelog -->

docs/conf.py

@@ -1,19 +1,35 @@
+import datetime
+
+# General information about the project.
 project = "openEO Aggregator"
+author = "Stefaan Lippens"
+copyright = f"2021 - {datetime.datetime.now():%Y}"
 
+# Sphinx extensions
 extensions = [
     "myst_parser",
     "sphinx_design",
     "sphinxcontrib.mermaid",
 ]
-myst_enable_extensions = ["colon_fence"]
+myst_enable_extensions = [
+    "colon_fence",
+]
 
+# Doc discovery settings
 root_doc = "index"
-html_theme = "furo"
-
-
 exclude_patterns = [
     "_build",
     "build",
     ".venv",
     "venv",
 ]
+
+# HTML theme settings
+html_theme = "furo"
+html_title = "openEO Aggregator"
+
+html_theme_options = {
+    "source_repository": "https://github.com/Open-EO/openeo-aggregator",
+    "source_branch": "master",
+    "source_directory": "docs/",
+}

docs/index.md

@@ -51,8 +51,16 @@ including, but not limited to:
 
 
 ```{toctree}
+:caption: Documentation
 :hidden:
 pages/installation.md
 pages/configuration.md
 pages/usage.md
 ```
+
+```{toctree}
+:caption: Development
+:hidden:
+pages/changelog
+pages/license
+```

docs/pages/changelog.md

@@ -0,0 +1,7 @@
+# Changelog
+
+
+```{include} ../../CHANGELOG.md
+:start-after: <!-- start changelog -->
+:end-before: <!-- end changelog -->
+```

docs/pages/configuration.md

@@ -2,12 +2,14 @@
 
 # Configuration
 
+:::{Attention}
+This documentation page is work in progress... 👷
+:::
 
 
 The openEO Aggregator can be configured through a `AggregatorBackendConfig` class
 
 
-
 ## Gunicorn configuration
 
 TODO

docs/pages/installation.md

@@ -1,6 +1,11 @@
 
 # Installation
 
+:::{Attention}
+This documentation page is work in progress... 👷
+:::
+
+
 The openEO Aggregator can be installed via pip:
 
 ```shell

docs/pages/license.md

@@ -0,0 +1,4 @@
+# License
+
+```{literalinclude} ../../LICENSE.txt
+```

docs/pages/usage.md

@@ -1,6 +1,11 @@
 
 # Usage
 
+:::{Attention}
+This documentation page is work in progress... 👷
+:::
+
+
 ## Run with Flask in development mode
 
 ```shell