From c64034ea0195bbc5fe753f694302b910ed837739 Mon Sep 17 00:00:00 2001 From: CasVT Date: Sun, 2 Jul 2023 13:14:19 +0200 Subject: [PATCH] Moved project management files into own folder --- .github/workflows/build_docs.yml | 33 +++++++++++++++++++ .github/workflows/deploy.yml | 20 ----------- .../docs-requirements.txt | 0 .../generate_api_docs.py | 12 +++++++ mkdocs.yml => project_management/mkdocs.yml | 1 + 5 files changed, 46 insertions(+), 20 deletions(-) create mode 100644 .github/workflows/build_docs.yml delete mode 100644 .github/workflows/deploy.yml rename docs-requirements.txt => project_management/docs-requirements.txt (100%) rename generate_api_docs.py => project_management/generate_api_docs.py (93%) rename mkdocs.yml => project_management/mkdocs.yml (99%) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml new file mode 100644 index 0000000..0bd0944 --- /dev/null +++ b/.github/workflows/build_docs.yml @@ -0,0 +1,33 @@ +name: Update and build docs + +on: + push: + branches: + - Development + +jobs: + update: + name: Update API docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install -r requirements.txt + - run: python3 project_management/generate_api_docs.py + + deploy: + name: Build docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - run: pip install -r project_management/docs-requirements.txt + - run: mkdocs gh-deploy --force -f project_management/mkdocs.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 29d8472..0000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Build and deploy docs - -on: - push: - branches: - - Development - -jobs: - deploy: - name: Deploy docs - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - uses: actions/setup-python@v2 - with: - python-version: 3.x - - run: pip install -r docs-requirements.txt - - run: mkdocs gh-deploy --force diff --git a/docs-requirements.txt b/project_management/docs-requirements.txt similarity index 100% rename from docs-requirements.txt rename to project_management/docs-requirements.txt diff --git a/generate_api_docs.py b/project_management/generate_api_docs.py similarity index 93% rename from generate_api_docs.py rename to project_management/generate_api_docs.py index 7daf5a9..7cf4c13 100644 --- a/generate_api_docs.py +++ b/project_management/generate_api_docs.py @@ -1,6 +1,12 @@ #!/usr/bin/env python3 #-*- coding: utf-8 -*- +from sys import path +from os.path import dirname + +path.insert(0, dirname(path[0])) + +from subprocess import run from typing import Union from frontend.api import (DataSource, NotificationServiceNotFound, ReminderNotFound, TemplateNotFound, api_docs) @@ -114,3 +120,9 @@ if current_content == result: else: with open(_folder_path('docs', 'api.md'), 'w+') as f: f.write(result) + + run(["git", "checkout", "Development"]) + run(["git", "add", _folder_path('docs', 'api.md')]) + run(["git", "commit", "-m", "Updated API docs"]) + run(["git", "push"]) + \ No newline at end of file diff --git a/mkdocs.yml b/project_management/mkdocs.yml similarity index 99% rename from mkdocs.yml rename to project_management/mkdocs.yml index 7f887a1..6c5b31f 100644 --- a/mkdocs.yml +++ b/project_management/mkdocs.yml @@ -5,6 +5,7 @@ site_author: Casvt repo_url: https://github.com/Casvt/MIND edit_uri: blob/Development/docs/ repo_name: Casvt/MIND +docs_dir: ../docs extra_css: - assets/css/extra.css