diff --git a/.github/workflows/clean-docs.yml b/.github/workflows/clean-docs.yml new file mode 100644 index 000000000..c20b1a05b --- /dev/null +++ b/.github/workflows/clean-docs.yml @@ -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 diff --git a/.github/workflows/generate-cs-docs.yml b/.github/workflows/generate-cs-docs.yml new file mode 100644 index 000000000..350bf7414 --- /dev/null +++ b/.github/workflows/generate-cs-docs.yml @@ -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 diff --git a/.github/workflows/generate-docs.yml b/.github/workflows/generate-lua-docs.yml similarity index 76% rename from .github/workflows/generate-docs.yml rename to .github/workflows/generate-lua-docs.yml index 2af6a09da..42b930917 100644 --- a/.github/workflows/generate-docs.yml +++ b/.github/workflows/generate-lua-docs.yml @@ -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 diff --git a/docs-landing-page/bg.jpg b/docs-landing-page/bg.jpg new file mode 100644 index 000000000..3a4ad0b50 Binary files /dev/null and b/docs-landing-page/bg.jpg differ diff --git a/docs-landing-page/cs_logo.png b/docs-landing-page/cs_logo.png new file mode 100644 index 000000000..b0854dc86 Binary files /dev/null and b/docs-landing-page/cs_logo.png differ diff --git a/docs-landing-page/index.html b/docs-landing-page/index.html new file mode 100644 index 000000000..fcb6bb06b --- /dev/null +++ b/docs-landing-page/index.html @@ -0,0 +1,25 @@ + + + + + LuaCs For Barotrauma + + + + +
+
+
+ +
+
+
+
+
+
+ +
+
+
+ + \ No newline at end of file diff --git a/docs-landing-page/landing.css b/docs-landing-page/landing.css new file mode 100644 index 000000000..7efcd8809 --- /dev/null +++ b/docs-landing-page/landing.css @@ -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%; + } +} \ No newline at end of file diff --git a/docs-landing-page/lua_logo.png b/docs-landing-page/lua_logo.png new file mode 100644 index 000000000..323f140a4 Binary files /dev/null and b/docs-landing-page/lua_logo.png differ diff --git a/doxygen/Doxyfile.conf b/doxygen/Doxyfile similarity index 99% rename from doxygen/Doxyfile.conf rename to doxygen/Doxyfile index 9493b8e36..b5250b10a 100644 --- a/doxygen/Doxyfile.conf +++ b/doxygen/Doxyfile @@ -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 diff --git a/doxygen/baro-client/Doxyfile.conf b/doxygen/baro-client/Doxyfile similarity index 100% rename from doxygen/baro-client/Doxyfile.conf rename to doxygen/baro-client/Doxyfile diff --git a/doxygen/baro-server/Doxyfile.conf b/doxygen/baro-server/Doxyfile similarity index 100% rename from doxygen/baro-server/Doxyfile.conf rename to doxygen/baro-server/Doxyfile diff --git a/doxygen/generate-all.bat b/doxygen/generate-all.bat deleted file mode 100644 index d01228479..000000000 --- a/doxygen/generate-all.bat +++ /dev/null @@ -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 \ No newline at end of file diff --git a/doxygen/generate.bat b/doxygen/generate.bat deleted file mode 100644 index 6f5e6837d..000000000 --- a/doxygen/generate.bat +++ /dev/null @@ -1,3 +0,0 @@ -if not exist "build" mkdir build - -doxygen Doxyfile.conf \ No newline at end of file