From ea88ab7f6c1896b9d2bf743b661832ab3ea438bc Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sat, 21 Oct 2023 22:54:49 +0200 Subject: [PATCH] [Docs] Clone and build wiki pages on docs.platypush.tech. --- .drone.yml | 6 +++++- .gitignore | 1 + docs/source/index.rst | 13 ++++++++++--- 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.drone.yml b/.drone.yml index 034f1d60..af633ee6 100644 --- a/.drone.yml +++ b/.drone.yml @@ -113,13 +113,17 @@ steps: commands: - echo "Installing required build dependencies" - - apk add --update --no-cache make py3-sphinx py3-myst-parser py3-pip $(cat platypush/install/requirements/alpine.txt) + - apk add --update --no-cache git make py3-sphinx py3-myst-parser py3-pip $(cat platypush/install/requirements/alpine.txt) - pip install -U sphinx-rtd-theme sphinx-book-theme - pip install . - mkdir -p /docs/current - export APPDIR=$PWD - rm -rf "$APPDIR/docs/build" - echo "Building the updated documentation" + - cd "$APPDIR/docs/source" + - git clone 'https://git.platypush.tech/platypush/platypush.wiki.git' wiki + - cd wiki + - ln -s Home.md index.md - cd "$APPDIR/docs" - make html - rm -f config*.yaml diff --git a/.gitignore b/.gitignore index 20fcb3ca..6cce0b4e 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ Session.vim /jsconfig.json /package.json /Dockerfile +/docs/source/wiki diff --git a/docs/source/index.rst b/docs/source/index.rst index 9c901e0a..01004dd0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,17 +7,24 @@ For more information on Platypush check out: * The `main page`_ of the project * The `Gitea page`_ of the project -* The `online wiki`_ for quickstart and examples * The `Blog articles`_ for inspiration on use-cases possible projects .. _main page: https://platypush.tech .. _Gitea page: https://git.platypush.tech/platypush/platypush -.. _online wiki: https://git.platypush.tech/platypush/platypush/wiki .. _Blog articles: https://blog.platypush.tech +.. toctree:: + :maxdepth: 3 + :caption: Wiki: + + wiki/index + wiki/Installation + wiki/Configuration + wiki/Installing-extensions + .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Reference: backends plugins