mirror of
https://github.com/august-alt/gpui.git
synced 2025-01-03 09:17:41 +03:00
docs, build: add documentation workflow
This commit is contained in:
parent
5cc8da87c9
commit
c932203c00
42
.github/workflows/publish-api-docs.yml
vendored
Normal file
42
.github/workflows/publish-api-docs.yml
vendored
Normal 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"
|
||||||
|
|
2
Doxyfile
2
Doxyfile
@ -1135,7 +1135,7 @@ GENERATE_HTML = YES
|
|||||||
# The default directory is: html.
|
# The default directory is: html.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# 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
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
|
||||||
# generated HTML page (for example: .htm, .php, .asp).
|
# generated HTML page (for example: .htm, .php, .asp).
|
||||||
|
Loading…
Reference in New Issue
Block a user