From 7b36b05355f140f5192f69f4f3d26dc56c8a1685 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sun, 28 Jan 2024 17:18:39 +0800 Subject: chore(docs): update config --- docs/source/conf.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/source/conf.py b/docs/source/conf.py index c2403d47..6d172231 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,17 +19,19 @@ with open(PYPROJECT, "r", encoding="utf8") as f: PROJECT_VERSION = DATA["project"]["version"] PROJECT_NAME = DATA["project"]["name"] AUTHOR_TABLE = DATA["project"]["authors"] -AUTHORS = ",".join([f"{aut['name']}<{aut['email']}>" for aut in AUTHOR_TABLE]) +AUTHORS = ",".join([f"{aut['name']}" for aut in AUTHOR_TABLE]) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = PROJECT_NAME # "IamAI" +project = PROJECT_NAME # "Infini" release = PROJECT_VERSION # "latest" -copyright = "2023-PRESENT, HydroRoll-Team." -author = "Hsiang Nianian" # AUTHORS +copyright = ( + "2023-PRESENT, HydroRoll-Team x 浊莲." +) +author = AUTHORS # "Hsiang Nianian" -# html_title = "Who am I? I am AI." +html_title = "INFINI GENERATOR II" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -65,8 +67,10 @@ gettext_uuid = True # optional. html_theme = "furo" html_static_path = ["../_static"] -html_logo = "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png" -html_favicon = html_logo +html_logo = ( + "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png" +) +# html_favicon = html_logo html_css_files = [ "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css", @@ -74,7 +78,7 @@ html_css_files = [ ] html_theme_options = { - "announcement": "documentation is still under construction now, welcome any contribution!", + # "announcement": "documentation is still under construction now, welcome any contribution!", "source_repository": "https://github.com/HydroRoll-Team/infini/", "source_branch": "master", "source_directory": "docs/source/", @@ -92,4 +96,4 @@ html_theme_options = { "class": "fa-brands fa-python", }, ], -} \ No newline at end of file +} -- cgit v1.2.3-70-g09d2 From 164d8e066f0759f380513a25d5c07fb77a039103 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sun, 28 Jan 2024 17:28:52 +0800 Subject: feat(workflows): add changelog for each --- .github/workflows/changelog.yml | 43 +++++++++++++++++++++++++++++++++++++++++ docs/source/changelog.md | 3 +++ 2 files changed, 46 insertions(+) create mode 100644 .github/workflows/changelog.yml (limited to 'docs') diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 00000000..7b315f1f --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,43 @@ +name: CHANGELOG + +on: + push: + tags: + - "v*" + # - v[0-9]+.[0-9]+.[0-9]+ + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + - name: Checkout Code + uses: actions/checkout@v3 + + - name: Update CHANGELOG + id: changelog + uses: requarks/changelog-action@v1 + with: + token: ${{ github.token }} + tag: ${{ github.ref_name }} + includeInvalidCommits: true + changelogFilePath: CHANGELOG.md + writeToFile: true + useGitmojis: false + + - name: Create Release + uses: ncipollo/release-action@v1.12.0 + with: + allowUpdates: true + draft: false + makeLatest: true + name: ${{ github.ref_name }} + body: ${{ steps.changelog.outputs.changes }} + token: ${{ github.token }} + + - name: Commit CHANGELOG.md + uses: stefanzweifel/git-auto-commit-action@v4 + with: + branch: master + commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]' + file_pattern: CHANGELOG.md \ No newline at end of file diff --git a/docs/source/changelog.md b/docs/source/changelog.md index efc8cca8..e5f0b545 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -10,3 +10,6 @@ https://patternbasedwriting.com/elementary_writing_success/list-4800-adjectives/ https://en.wikipedia.org/wiki/Lists_of_colors --> + +```{include} ../../CHANGELOG.md +``` \ No newline at end of file -- cgit v1.2.3-70-g09d2 From c71fe6758fdb8c2c8338d77b98117633df673c27 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sun, 28 Jan 2024 17:29:45 +0800 Subject: chore(docs): refresh changelog.md --- docs/source/changelog.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'docs') diff --git a/docs/source/changelog.md b/docs/source/changelog.md index e5f0b545..769b66e7 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1,5 +1,3 @@ -# 变更日志 -