diff --git a/.github/workflows/docs2ghpages.yml b/.github/workflows/docs2ghpages.yml index 1d3572d..08ff3fa 100644 --- a/.github/workflows/docs2ghpages.yml +++ b/.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: diff --git a/CHANGELOG.md b/CHANGELOG.md index cfc086e..ae3e315 100644 --- a/CHANGELOG.md +++ b/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/). + + ## 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) + + + diff --git a/docs/conf.py b/docs/conf.py index 14010e4..3e0f707 100644 --- a/docs/conf.py +++ b/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/", +} diff --git a/docs/index.md b/docs/index.md index 1d99811..18e2ae3 100644 --- a/docs/index.md +++ b/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 +``` diff --git a/docs/pages/changelog.md b/docs/pages/changelog.md new file mode 100644 index 0000000..2d54f25 --- /dev/null +++ b/docs/pages/changelog.md @@ -0,0 +1,7 @@ +# Changelog + + +```{include} ../../CHANGELOG.md +:start-after: +:end-before: +``` diff --git a/docs/pages/configuration.md b/docs/pages/configuration.md index 1b6af9d..e76bd63 100644 --- a/docs/pages/configuration.md +++ b/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 diff --git a/docs/pages/installation.md b/docs/pages/installation.md index b9eae91..d9999cf 100644 --- a/docs/pages/installation.md +++ b/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 diff --git a/docs/pages/license.md b/docs/pages/license.md new file mode 100644 index 0000000..de23f43 --- /dev/null +++ b/docs/pages/license.md @@ -0,0 +1,4 @@ +# License + +```{literalinclude} ../../LICENSE.txt +``` diff --git a/docs/pages/usage.md b/docs/pages/usage.md index be3295f..74b2ffa 100644 --- a/docs/pages/usage.md +++ b/docs/pages/usage.md @@ -1,6 +1,11 @@ # Usage +:::{Attention} +This documentation page is work in progress... 👷 +::: + + ## Run with Flask in development mode ```shell