Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add the workflow job to deploy to gh-pages #5

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
23 changes: 14 additions & 9 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: CI/CD
name: CI-CD

on:
push:
Expand All @@ -8,11 +8,11 @@ on:
branches: [ main ]

jobs:
build:
execute-regression:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-latest, ubuntu-20.04, ubuntu-18.04, ubuntu-20.04, ubuntu-latest, windows-latest]
os: [macos-latest, ubuntu-latest, windows-latest]
platform: [x86, x64]
compiler: [gnu, clang]

Expand All @@ -36,15 +36,17 @@ jobs:
test-exclude-file-pattern: |
mock+
crash_test.c
test-exclude-file-pattern-windows: |
test_struct_fields_types_clean+
compiler-options-for-tests: |
-I.
-I./test/structs
-I./include/

build-and-deploy-gh_pages:
runs-on: ubuntu-latest
needs: build
if: github.event_name == 'push' #&& contains(github.ref, 'refs/for/main')
needs: execute-regression
if: github.event_name == 'push' && contains(github.ref, 'refs/heads/main')
steps:
- name: Checkout 🛎️
uses: actions/[email protected]
Expand All @@ -53,16 +55,19 @@ jobs:

- name: Install and Build 🔧
run: |
pip3 install themata
sudo apt-get install -y python3 python3-setuptools python3-pip python3-sphinx
python -m pip install --upgrade pip
python -m pip install themata m2r2
sudo apt-get install -y clang doxygen make
cd ./docs/
bash ./make.sh
sudo bash ./make.sh
cd ../

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@3.6.1
uses: JamesIves/github-pages-deploy-action@4.0.0
with:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_FOR_CI_CD }}
BRANCH: gh-pages # The branch the action should deploy to.
BRANCH: gh-pages
FOLDER: docs/build/html
CLEAN: true

Expand Down
38 changes: 20 additions & 18 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# https://github.com/vovkos/doxyrest#2-prepare-configuration-files

PROJECT_NAME = "libmetaref"
INPUT = ../README.md ../include/
GENERATE_XML = YES
GENERATE_HTML = YES
GENERATE_LATEX = NO
XML_OUTPUT = build/html/reference/xml/
HTML_OUTPUT = build/html/reference/
XML_PROGRAMLISTING = NO
CASE_SENSE_NAMES = NO
HIDE_UNDOC_RELATIONS = YES
EXTRACT_ALL = YES
USE_MDFILE_AS_MAINPAGE = ../README.md
SEARCH_INCLUDES = YES
INHERIT_DOCS = YES
MARKDOWN_SUPPORT = YES
RECURSIVE = YES
# https://github.com/vovkos/doxyrest#2-prepare-configuration-files

PROJECT_NAME = "libmetaref"
INPUT = ../README.md ../include/
GENERATE_XML = YES
GENERATE_HTML = YES
GENERATE_LATEX = NO
XML_OUTPUT = build/html/reference/xml/
HTML_OUTPUT = build/html/reference/
XML_PROGRAMLISTING = NO
CASE_SENSE_NAMES = NO
HIDE_UNDOC_RELATIONS = YES
EXTRACT_ALL = YES
USE_MDFILE_AS_MAINPAGE = ../README.md
SEARCH_INCLUDES = YES
INHERIT_DOCS = YES
MARKDOWN_SUPPORT = YES
RECURSIVE = YES
PREDEFINED = "__STRUCT_FILE__=Docygen.h" \
"__STRUCT_NAME__=Docygen"
173 changes: 105 additions & 68 deletions docs/_static/css/libmetaref.css
Original file line number Diff line number Diff line change
@@ -1,68 +1,105 @@



.header {
position: absolute;
background-color: #292929;
color: white;
top: 0;
padding-top: 110px;
left: 0;
right: 0;
width: 100% !important;
height: 400px;
text-align: center;
vertical-align: middle;
overflow: hidden;
}

.header .title {
color: white;
font-size: 300%;
}

.header .brief {
margin-top: 20px !important;
}

.header img {
width: 100px;
height: 100px;
}

.header .linksdiv {
padding-top: 60px;
min-height: 100%;
overflow: hidden;
}

.header .link {
margin: 10px;
padding: 12px;
padding-left: 35px;
padding-right: 35px;
background: white;
color: #292929 !important;
text-decoration: none;
border-radius: 5px;
border: white 1px solid;
}

.header .link:hover {
text-decoration: none;
background: #292929;
color: white !important;
}

.header p {
color: white !important;
font-size: 21px;
margin-top: 5px;
text-align: center;
width: 50%;
margin:0 auto;
}

.bodywrapper {
min-height: 80vh;
}



.header {
position: absolute;
background-color: #292929;
color: white;
top: 0;
padding-top: 110px;
left: 0;
right: 0;
width: 100% !important;
height: 400px;
text-align: center;
vertical-align: middle;
overflow: hidden;
}

.header .title {
color: white;
font-size: 300%;
}

.header .brief {
margin-top: 20px !important;
}

.header img {
width: 100px;
height: 100px;
}

.header .linksdiv {
padding-top: 60px;
min-height: 100%;
overflow: hidden;
}

.header .link {
margin: 10px;
padding: 12px;
padding-left: 35px;
padding-right: 35px;
background: white;
color: #292929 !important;
text-decoration: none;
border-radius: 5px;
border: white 1px solid;
}

.header .link:hover {
text-decoration: none;
background: #292929;
color: white !important;
}

.header p {
color: white !important;
font-size: 21px;
margin-top: 5px;
text-align: center;
width: 50%;
margin:0 auto;
}

.bodywrapper {
min-height: 80vh;
}

.width-45-percent {
width: 45%;
}

.width-55-percent {
width: 55%;
}

.width-50-percent {
width: 50%;
}

.two-sided {
display: flex;
}

.two-sided .left-side {
padding-right: 2%;
padding-left: 0;
}

.two-sided .title {
font-weight: bold;
}

.two-sided pre {
overflow-y: scroll;
}

.bold {
font-weight: bold;
}

.doc-sphinx-info a {
color: #5682d1 !important;
}
Loading