Skip to content

Commit

Permalink
Generate MEOS documentation with doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
estebanzimanyi committed Oct 7, 2023
1 parent ed18f85 commit 752a109
Show file tree
Hide file tree
Showing 10 changed files with 2,925 additions and 98 deletions.
12 changes: 12 additions & 0 deletions .github/workflows/check-code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,19 @@ name: Check code

on:
push:
paths:
- '.github/workflows/check-code.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages
pull_request:
paths:
- '.github/workflows/check-code.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

jobs:
license_check:
Expand Down
17 changes: 12 additions & 5 deletions .github/workflows/clang.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,20 @@ name: Build for Ubuntu with clang

on:
push:
branches-ignore:
- 'gh-pages'
tags: []
paths:
- '.github/workflows/clang.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

pull_request:
branches-ignore:
- 'gh-pages'
paths:
- '.github/workflows/clang.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

jobs:
Test_clang:
Expand Down
11 changes: 11 additions & 0 deletions .github/workflows/macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,19 @@ name: Build for macOS
on:
workflow_dispatch:
push:
paths:
- '.github/workflows/macos.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

pull_request:
paths:
- '.github/workflows/macos.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

jobs:
Expand Down
45 changes: 45 additions & 0 deletions .github/workflows/meos_generate_dev_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# This is a basic workflow to help you get started with Actions

name: Generate MEOS documentation with Doxygen

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on:
push:
paths:
- '.github/workflows/meos_generate_dev_docs.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
- './doxygen/**'
# branches:
# - master
# - develop

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3

- name: Doxygen Action
uses: mattnotmitt/doxygen-action@v1.9.5
with:
# Path to Doxyfile
doxyfile-path: "./doxygen/Doxyfile_gha" # default is ./Doxyfile
# Working directory
working-directory: "." # default is .

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Default Doxyfile build documentation to html directory.
# Change the directory if changes in Doxyfile
publish_dir: ./html
11 changes: 11 additions & 0 deletions .github/workflows/pgversion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,19 @@ name: Main Build
on:
workflow_dispatch:
push:
paths:
- '.github/workflows/pgversion.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

pull_request:
paths:
- '.github/workflows/pgversion.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
branch_ignore: gh-pages

jobs:
Expand Down
13 changes: 13 additions & 0 deletions .github/workflows/windows_msys2.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,22 @@ name: Build for Windows

on:
push:
paths:
- '.github/workflows/windows_msys2.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
# branches: [ main ]
branch_ignore: gh-pages

pull_request:
paths:
- '.github/workflows/windows_msys2.yml'
- './meos/**'
- './mobilitydb/**'
- './postgis/**'
# branches: [ main ]
branch_ignore: gh-pages
workflow_dispatch:

jobs:
Expand Down
Binary file added doc/images/mobilitydb-logo-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 752a109

Please sign in to comment.