docs, build: add documentation workflow

This commit is contained in:
august-alt 2021-07-27 16:46:55 +04:00
parent 5cc8da87c9
commit c932203c00
2 changed files with 43 additions and 1 deletions

42
.github/workflows/publish-api-docs.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: publish-api-doc
on:
push:
branches:
- master
jobs:
api-doc:
runs-on: ubuntu-latest
steps:
- name: Git Checkout
uses: actions/checkout@v2
- name: Create clean documentation branch
run: git checkout -b documentation
- name: Install doxygen
run: sudo apt-get install doxygen
- name: Generate autodocs for gpui editor
run: doxygen
- name: Add generated autodocs to Git repo in the documentation branch
run: |
git config --global user.email "gpui-github-bot@basealt.ru"
git config --global user.name "$GITHUB_WORKFLOW GitHub action"
git add -f docs
git commit -am "docs: add auto-generated developer documentation"
- name: Publish autodocs as GitHub pages
run: git push -f origin documentation:documentation
- name: Result URLs
run: |
REPO_OWNER=$(echo $GITHUB_REPOSITORY | cut -d '/' -f 1)
REPO_NAME=$(echo $GITHUB_REPOSITORY | cut -d '/' -f 2)
echo "Documentation on a github.io: https://$REPO_OWNER.github.io/$REPO_NAME/docs"
echo ""
echo "Documentation branch: $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/tree/documentation"

View File

@ -1135,7 +1135,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = ./
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).