VladPolskiy/mariadb-connector-python
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-connector-python.git synced 2025-08-20 16:36:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[misc] doc generation correction

Browse Source
This commit is contained in:
Diego Dupin
2025-07-02 19:46:50 +02:00
parent cf7d09ca57
commit db3483b525
19 changed files with 784 additions and 930 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
.github/workflows/release.yml vendored
View File

@ -1,9 +1,11 @@
name: Generate and Update API Docs
on:
workflow_dispatch: # Allow manual triggering
workflow_dispatch:
branches: [1.1]
release:
types: [published] # Runs when release is published
types: [published]
branches: [1.1]
jobs:
update-docs:
@ -102,10 +104,24 @@ jobs:
run: |
# Remove existing documentation in target subdirectory
mkdir -p mariadb-docs/connectors/mariadb-connector-python/api/
rm -rf mariadb-docs/connectors/mariadb-connector-python/api/*
rm -f mariadb-docs/connectors/mariadb-connector-python/api.md
rm -f mariadb-docs/connectors/mariadb-connector-python/bugs.md
rm -f mariadb-docs/connectors/mariadb-connector-python/connection.md
rm -f mariadb-docs/connectors/mariadb-connector-python/constants.md
rm -f mariadb-docs/connectors/mariadb-connector-python/cursor.md
rm -f mariadb-docs/connectors/mariadb-connector-python/faq.md
rm -f mariadb-docs/connectors/mariadb-connector-python/install.md
rm -f mariadb-docs/connectors/mariadb-connector-python/license.md
rm -f mariadb-docs/connectors/mariadb-connector-python/module.md
rm -f mariadb-docs/connectors/mariadb-connector-python/pool.md
rm -f mariadb-docs/connectors/mariadb-connector-python/pooling.md
rm -f mariadb-docs/connectors/mariadb-connector-python/index.md
rm -f mariadb-docs/connectors/mariadb-connector-python/usage.md
rm -f mariadb-docs/connectors/mariadb-connector-python/release.md
# Copy new documentation
cp -r docs/_build/markdown/* mariadb-docs/connectors/mariadb-connector-python/api/
cp -r docs/_build/markdown/* mariadb-docs/connectors/mariadb-connector-python/
mv -f mariadb-docs/connectors/mariadb-connector-python/index.md mariadb-docs/connectors/mariadb-connector-python/README.md
# Optional: Add any additional processing here
# e.g., update index files, fix relative links, etc.
@ -116,7 +132,7 @@ jobs:
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git checkout -b auto-docs-update-${{ github.run_number }}
git add connectors/mariadb-connector-python/api/
git add connectors/mariadb-connector-python/
git commit -m "Update API documentation from ${{ github.repository }}"
git push https://x-access-token:${{ secrets.SPHINX_TOKEN }}@github.com/rusher/mariadb-docs.git auto-docs-update-${{ github.run_number }}