documentaion generation
This commit is contained in:
Oiltanker
20
.github/workflows/clean-docs.yml
vendored
Normal file
20
.github/workflows/clean-docs.yml
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
name: Clean Docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout branch
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: docs-landing-page
|
||||
43
.github/workflows/generate-cs-docs.yml
vendored
Normal file
43
.github/workflows/generate-cs-docs.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
name: Generate Docs - Cs
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: ["Clean Docs"]
|
||||
types:
|
||||
- completed
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout branch
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Create directories
|
||||
run: mkdir -p doxygen/build ; mkdir -p doxygen/build/baro-server ; mkdir -p doxygen/build/baro-client
|
||||
|
||||
- name: Build server documentation
|
||||
uses: mattnotmitt/doxygen-action@v1
|
||||
with:
|
||||
working-directory: 'doxygen/baro-server'
|
||||
doxyfile-path: './Doxyfile'
|
||||
|
||||
- name: Build client documentation
|
||||
uses: mattnotmitt/doxygen-action@v1
|
||||
with:
|
||||
working-directory: 'doxygen/baro-client'
|
||||
doxyfile-path: './Doxyfile'
|
||||
|
||||
- name: Build containing documentation
|
||||
uses: mattnotmitt/doxygen-action@v1
|
||||
with:
|
||||
working-directory: 'doxygen/'
|
||||
doxyfile-path: './Doxyfile'
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: doxygen/build
|
||||
destination_dir: cs-docs
|
||||
keep_files: true
|
||||
@@ -1,14 +1,18 @@
|
||||
name: Generate Docs
|
||||
on:
|
||||
workflow_dispatch:
|
||||
name: Generate Docs - Lua
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows: ["Clean Docs"]
|
||||
types:
|
||||
- completed
|
||||
|
||||
jobs:
|
||||
docs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
- name: Checkout branch
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- uses: leafo/gh-actions-lua@v8.0.0
|
||||
with:
|
||||
@@ -39,3 +43,5 @@ jobs:
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: docs/html
|
||||
destination_dir: lua-docs
|
||||
keep_files: true
|
||||
BIN
docs-landing-page/bg.jpg
Normal file
BIN
docs-landing-page/bg.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
BIN
docs-landing-page/cs_logo.png
Normal file
BIN
docs-landing-page/cs_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
25
docs-landing-page/index.html
Normal file
25
docs-landing-page/index.html
Normal file
@@ -0,0 +1,25 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>LuaCs For Barotrauma</title>
|
||||
<link rel="stylesheet" href="landing.css">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
</head>
|
||||
<body>
|
||||
<a href="lua-docs/index.html"><div id="lua-docs" class="common-docs">
|
||||
<div id="lua-bg" class="inner-bg">
|
||||
<div id="lua-inner" class="inner-docs">
|
||||
<img src="lua_logo.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div></a>
|
||||
<a href="cs-docs/html/index.html"><div id="cs-docs" class="common-docs">
|
||||
<div id="cs-bg" class="inner-bg">
|
||||
<div id="cs-inner" class="inner-docs">
|
||||
<img src="cs_logo.png" />
|
||||
</div>
|
||||
</div>
|
||||
</div></a>
|
||||
</body>
|
||||
</html>
|
||||
132
docs-landing-page/landing.css
Normal file
132
docs-landing-page/landing.css
Normal file
@@ -0,0 +1,132 @@
|
||||
body{
|
||||
overflow: hidden;
|
||||
font-size: 100%;
|
||||
background-color: #777;
|
||||
}
|
||||
|
||||
.common-docs{
|
||||
z-index: 1;
|
||||
text-justify: auto;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
transition-property: transform;
|
||||
transition-duration: 0.5s;
|
||||
transition-timing-function: ease-in-out;
|
||||
overflow: hidden;
|
||||
}
|
||||
#lua-docs{
|
||||
left: -10%;
|
||||
right: 50%;
|
||||
}
|
||||
#cs-docs{
|
||||
right: -10%;
|
||||
left: 50%;
|
||||
}
|
||||
|
||||
#cs-docs::before,#lua-docs::before{
|
||||
content: "";
|
||||
background: url(bg.jpg) repeat;
|
||||
background-size: 80%;
|
||||
background-blend-mode: luminosity;
|
||||
filter: blur(2px);
|
||||
position: absolute;
|
||||
height: 200%;
|
||||
width: 200%;
|
||||
}
|
||||
#lua-docs::before{
|
||||
background-color: rgba(49, 49, 135, 1);
|
||||
}
|
||||
#cs-docs::before{
|
||||
background-color: rgba(105, 44, 120, 1);
|
||||
}
|
||||
|
||||
.common-docs:hover{
|
||||
z-index: 2;
|
||||
font-size: 300%;
|
||||
transform: scale(1.05);
|
||||
}
|
||||
|
||||
.inner-bg{
|
||||
position: relative;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
transition-duration: 0.5s;
|
||||
transition-timing-function: ease-in-out;
|
||||
}
|
||||
.inner-bg:hover{
|
||||
background-color: rgba(255, 255, 255, 0.35);
|
||||
}
|
||||
|
||||
.inner-docs{
|
||||
height: 100%;
|
||||
width: 100%;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
position: relative;
|
||||
background: radial-gradient(circle, #222, rgba(0, 0, 0, 0));
|
||||
}
|
||||
|
||||
|
||||
@media (min-width: 80em) {
|
||||
.inner-docs img{
|
||||
height: 30%;
|
||||
width: auto;
|
||||
}
|
||||
.common-docs{
|
||||
transform: skewX(-11deg);
|
||||
}
|
||||
#cs-docs::before,#lua-docs::before{
|
||||
transform: skewX(11deg);
|
||||
}
|
||||
.common-docs:hover{
|
||||
transform: skewX(-11deg) scale(1.05);
|
||||
}
|
||||
.inner-docs{
|
||||
transform: skewX(11deg);
|
||||
}
|
||||
.inner-docs img{
|
||||
height: 30%;
|
||||
width: auto;
|
||||
}
|
||||
}
|
||||
@media (max-width: 80em) {
|
||||
.common-docs{
|
||||
transform: skewX(-9deg);
|
||||
}
|
||||
#cs-docs::before,#lua-docs::before{
|
||||
transform: skewX(9deg);
|
||||
}
|
||||
.common-docs:hover{
|
||||
transform: skewX(-9deg) scale(1.05);
|
||||
}
|
||||
.inner-docs{
|
||||
transform: skewX(9deg);
|
||||
}
|
||||
.inner-docs img{
|
||||
height: 30%;
|
||||
width: auto;
|
||||
}
|
||||
}
|
||||
@media (max-width: 70em) {
|
||||
.common-docs{
|
||||
transform: skewX(0deg);
|
||||
}
|
||||
#cs-docs::before,#lua-docs::before{
|
||||
transform: skewX(0deg);
|
||||
}
|
||||
.common-docs:hover{
|
||||
transform: skewX(0deg) scale(1.05);
|
||||
}
|
||||
.inner-docs{
|
||||
transform: skewX(0deg);
|
||||
}
|
||||
.inner-docs img{
|
||||
height: auto;
|
||||
width: 50%;
|
||||
}
|
||||
}
|
||||
BIN
docs-landing-page/lua_logo.png
Normal file
BIN
docs-landing-page/lua_logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
@@ -1,3 +1,9 @@
|
||||
@INCLUDE_PATH = baro-server
|
||||
@INCLUDE = baro-server/Doxyfile
|
||||
|
||||
@INCLUDE_PATH = baro-client
|
||||
@INCLUDE = baro-client/Doxyfile
|
||||
|
||||
# Doxyfile 1.9.4
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
@@ -1,13 +0,0 @@
|
||||
if not exist "build" mkdir build
|
||||
if not exist "build\baro-server" mkdir build\baro-server
|
||||
if not exist "build\baro-client" mkdir build\baro-client
|
||||
|
||||
cd baro-client
|
||||
doxygen Doxyfile.conf
|
||||
cd ..
|
||||
|
||||
cd baro-server
|
||||
doxygen Doxyfile.conf
|
||||
cd ..
|
||||
|
||||
doxygen Doxyfile.conf
|
||||
@@ -1,3 +0,0 @@
|
||||
if not exist "build" mkdir build
|
||||
|
||||
doxygen Doxyfile.conf
|
||||
Reference in New Issue
Block a user