godotengine/doc-status
1
0
Fork 0
mirror of https://github.com/godotengine/doc-status.git synced 2025-12-31 13:48:23 +03:00
Code Issues Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Hugo Locurcio
2020-02-26 19:56:46 +01:00
commit f69e63d931
10 changed files with 155 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.editorconfig Normal file
View File

@@ -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

5
.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
# Hugo's default output directory
/public/
# Automatically generated by `build.sh`
content/_index.md

15
.travis.yml Normal file
View File

@@ -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

21
LICENSE.md Normal file
View File

@@ -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.

12
README.md Normal file
View File

@@ -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.

23
build.sh Executable file
View File

@@ -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"

6
config.toml Normal file
View File

@@ -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"]

16
layouts/index.html Normal file
View File

@@ -0,0 +1,16 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="author" content="Godot Engine">
<meta name="description" content="View the current completion status of the Godot class reference online.">
<meta name="theme-color" content="#3d8fcc">
<title>{{ .Site.Title }}</title>
<link rel="icon" href="favicon.png">
<link rel="stylesheet" href="main.css">
</head>
<body>
{{ .Content }}
</body>
</html>

BIN
static/favicon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

45
static/main.css Normal file
View File

@@ -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;
}