public_mirrors
/
doc-status
mirror of https://github.com/godotengine/doc-status.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Online Godot class reference status
64 Commits 3 Branches 0 Tags 1.6 MiB
JavaScript 39%
CSS 28.8%
Shell 26.1%
HTML 6.1%
Go to file
TechnoPorg c9714e938f
Make the class reference table sortable (#28) 
The main table's headers are now clickable to sort columns in ascending or descending order.
String columns are sorted alphabetically, description columns are sorted by MISSING vs. OK, and numeric columns are sorted by relative percentages.
A custom JS sorting implementation is used, both to avoid a large dependency and to handle the unique format of these table entries.
The cursor when hovering over table headers indicates that they can be interacted with.
 		2023-10-11 23:06:11 +02:00
.github GitHub Actions: Update Hugo to 0.101.0 (#20) 2022-06-29 19:07:17 +02:00
layouts Make the class reference table sortable (#28) 2023-10-11 23:06:11 +02:00
static Make the class reference table sortable (#28) 2023-10-11 23:06:11 +02:00
.editorconfig Initial commit 2020-02-26 20:01:37 +01:00
.gitignore Decrease opacity of non-applicable documentation items (#25) 2023-02-01 12:20:21 +01:00
LICENSE.txt Change copyrights for consistency with the @godotengine organization 2020-05-23 14:16:40 +02:00
README.md Fix reference to doc_status.py in README (#23) 2022-08-20 00:22:45 +02:00
build.sh Add platform exporters to the list of classes 2023-07-13 16:27:09 +02:00
config.toml Fade out `0/0` completion ratios as there's nothing to document 2020-06-15 21:26:19 +02:00

README.md

Godot class reference status

View the completion status of the Godot class reference (updated daily).

View

How it works

  • First, build.sh performs the following operations:
    • Clone the Godot Git repository to a temporary directory.
    • Run doc/tools/doc_status.py to generate a Markdown table, with the output redirected to a file. A static header is added at the beginning of the file as well.
    • Some text manipulation is done on the generated Markdown file to improve readability and visual grepping.
  • Hugo is used to build the HTML template with the referenced Markdown data into a static HTML page.
  • The generated website is deployed to GitHub Pages.

Every day, there's a continuous integration step that runs the tasks above to keep the page up-to-date.

Development

Follow these instructions to set up this site locally for development purposes:

  • Install Hugo for your operating system.
  • Run the build.sh script to clone the Godot repository, generate a Markdown file and build the website.
    • On Windows 10, you should be able to run this script using the WSL.
  • Run hugo server while working on the website CSS/JavaScript. The local server will reload automatically on file changes.
    • If you need to regenerate content/_index.md, run build.sh again. You can do this while having the development server running.

License

Unless otherwise specified, files in this repository are licensed under the MIT license. See LICENSE.txt for more information.