From f69e63d93154bea6bc37f34c4eec44ce33663edc Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 26 Feb 2020 19:56:46 +0100 Subject: [PATCH] Initial commit --- .editorconfig | 12 ++++++++++++ .gitignore | 5 +++++ .travis.yml | 15 +++++++++++++++ LICENSE.md | 21 +++++++++++++++++++++ README.md | 12 ++++++++++++ build.sh | 23 +++++++++++++++++++++++ config.toml | 6 ++++++ layouts/index.html | 16 ++++++++++++++++ static/favicon.png | Bin 0 -> 1929 bytes static/main.css | 45 +++++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 155 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 LICENSE.md create mode 100644 README.md create mode 100755 build.sh create mode 100644 config.toml create mode 100644 layouts/index.html create mode 100644 static/favicon.png create mode 100644 static/main.css diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..2aab0a2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_style = space +indent_size = 2 +insert_final_newline = true +trim_trailing_whitespace = true + +[Makefile] +indent_style = tab diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2d89e43 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Hugo's default output directory +/public/ + +# Automatically generated by `build.sh` +content/_index.md diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7cd7a47 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +os: linux +dist: bionic +# Python is required to run `doc_status.py` +language: python + +python: + - 3.7.1 + +install: + - curl -LO https://github.com/gohugoio/hugo/releases/download/v0.65.3/hugo_0.65.3_Linux-64bit.tar.gz + - tar xf hugo_0.65.3_Linux-64bit.tar.gz hugo + - sudo mv hugo /usr/local/bin/ + +script: + - ./build.sh diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..149ba76 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright © 2020 Hugo Locurcio and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5d0515f --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Godot class reference status + +View the completion status of the Godot class reference (updated daily). + +## [View](https://godot-doc-status.github.io/) + +## License + +Copyright © 2020 Hugo Locurcio and contributors + +- Unless otherwise specified, files in this repository are licensed under the + MIT license, see [LICENSE.md](LICENSE.md) for more information. diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..48ff135 --- /dev/null +++ b/build.sh @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +set -euo pipefail +IFS='$\n\t' + +TMP="$(mktemp -d)" +git clone --depth=1 https://github.com/godotengine/godot.git "$TMP" + +# Generate a Markdown table of the class reference coverage. +mkdir -p content/ +rm -f content/index.md + +# Add Git commit information to the generated page. +COMMIT_HASH="$(git -C "$TMP" rev-parse --short=9 HEAD)" +echo -e "Generated from commit [$COMMIT_HASH](https://github.com/godotengine/godot/commit/$COMMIT_HASH).\n" > content/_index.md + +# Trim the first line of the output to get a valid Markdown table. +python3 "$TMP/doc/tools/doc_status.py" -u "$TMP/doc/classes" | tail -n +2 >> content/_index.md + +# Build the website. +hugo + +rm -rf "$TMP" diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..8bb807f --- /dev/null +++ b/config.toml @@ -0,0 +1,6 @@ +baseURL = "https://godot-doc-status.github.io/" +languageCode = "en-us" +title = "Godot class reference status" + +# This is a single-page website, no need to generate a sitemap and RSS feed. +disableKinds = ["sitemap", "RSS"] diff --git a/layouts/index.html b/layouts/index.html new file mode 100644 index 0000000..47055bc --- /dev/null +++ b/layouts/index.html @@ -0,0 +1,16 @@ + + + + + + + + + {{ .Site.Title }} + + + + + {{ .Content }} + + diff --git a/static/favicon.png b/static/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..ac69f11e014b8a64542ec956ea5f36e712bd26cc GIT binary patch literal 1929 zcmV;42X^?0P)a&hkDhV#IKmkkd* zcuODpiN9?SKdjUrzG%Y@SP;F3H%Y(N2;yq3Nea@M#7;abZO)s-HE4sjXa_EEa;}co z4C0rW;Pp&!4(k9tXN?-;y)Vjf{L}a0m*D$+dvJmqF*sL*#w5*ULfawMp$TGu0-jyY zI1mG|I9CHY2Z3_pz4Z6L>TCotpEfxj-emUYTnw1E+aXTgB)uaJ_THp~LnD~Cx!wpc znO7-F0Oq$Ko#F-Q9(#_1;TeBp&rM1=c%!t^_0|BvJPG1dF{3om^+tfV$g7k9tN~ii z)quTPwGrSQ_!~|w4D}BGi2T+ij%LEjRZ9S38O@{mu3f%k^aE#wg0X7&CJL}tQk84v^jWR?PUo1w&If*YmkhFZe~e3 z|Jxr@Fz?LyqL$z71JsfTS;5=rQZ`U zY*#4771WYFR5iBKg3~em*7-$eVyU{Ro$Mhtzm|qFEvhEqP2V8OC~qVHsI9G~n>TLK z`STYjB_)M`){btPb|kXTou7U*l3F{v2}ns!K@7w~Ok4bnvPOEtCrG^n>=UzX!NbDB z=*>6YqQC#`A2u`Sjbyc0F+v=R5=2^mB@u>ahkgl#b!4$vNUt|M6XUHn-=^@eZ~}n6 zVwQRd$f;~1prWFJUVrTk2ztTrNm+?#^uBPr99LqB2mmfe7uoe0yZ;dZ=gytC7Xz`G zhDrjmE1J|v0MD$e+d{zUQ>P)su8kctjsQmsRW6eFKj7J(585&?uCWf|oH=urfKH}~ zS8D`xbXf@4vuCeEVHl#o^7HX_Ir6HS2>|eH&u8U@cmlxXD9+x!`v_?7>{f3Iq?I-h z5Ey87C~V1+rDU;Mv0L;y0V8&Yk(F^QS-iwy98nYrNGYjTF9F_cuLrQu&6_*#1yLF= zE#>6oP-tc){Ck}MSa?eyM;na8X;RtX(69Yi(dr4)`qEaE`pins+l0!FH zIea#v04p~>4cT_4J86X71ZKFMD(4SQl--DdScoZ8XsMKdzSz6|A@q)apUw>`B)|;} zUy^V=#ni)*Mt4cTlp_%auBWJP=~z`z(?Y1l15?ZCQgji{0Nq=zC%4Q$71O|0=f=1F zg4|$!LOK$X zYh?$gHYvTr3cqs^1+rq#M-~u(HfReDaDfxth=Ev$31Fp{e*%_MzY$i*rsXgX<-*5YCa^+I)jLhwlz;ntC{*f&KTke#6zICg1xR z?MFj%Q9BS0Opmgw@rlygzQG-Gd{{7pGb#yf&=wrv0w=f;1F;Yjv1RyRGq_#?mnGiM z2%-mY6&Ux+ebFD_`U1=!HWDfaVCTzqhQM!feFu^t{*29~k^$8DBHsA$CtQC*rx(A@ zo20-2(D?_rk^b_231So{YfNIXD}L(u23VC}mb|&)#z(Qby25QTTGCdYf4qv$j5TwhbKM0w=f;W5E4_ z42u$P692@`7jL63XCr1B>(qRlIAM6k-|!ATUIz0Y(dK2(XAeB^z=MAS4*8~-AMHOz P00000NkvXXu0mjfyF8U* literal 0 HcmV?d00001 diff --git a/static/main.css b/static/main.css new file mode 100644 index 0000000..6ab4b55 --- /dev/null +++ b/static/main.css @@ -0,0 +1,45 @@ +:root { + --body-background-color: hsl(0, 0%, 100%); + --body-color: hsl(0, 0%, 25%); +} + +@media (prefers-color-scheme: dark) { + :root { + --body-background-color: hsl(0, 0%, 20%); + --body-color: hsl(0, 0%, 85%); + } +} + +body { + background-color: var(--body-background-color); + color: var(--body-color); + /* Use a modern font stack inspired by Bootstrap 4. */ + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; +} + +table { + border-collapse: collapse; +} + +td { + border: 1px solid hsla(0, 0%, 50%, 50%); + padding: 0.25rem 0.5rem; +} + +tr:hover { + background-color: hsla(0, 0%, 50%, 25%); +} + +tr:nth-child(even) { + background-color: hsla(0, 0%, 50%, 10%); +} + +tr:nth-child(even):hover { + background-color: hsla(0, 0%, 50%, 35%); +} + +/* Align class names to the right for better readability and highlight them. */ +td:first-child { + font-weight: bold; + text-align: right; +}