mirror-godotengine/doc-status
1
0
Fork 0
mirror of https://github.com/godotengine/doc-status.git synced 2025-12-10 05:51:20 +03:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of godotengine/doc-status
68 commits 2 branches 0 tags 845 KiB
Find a file
Exact
dependabot[bot] e8cd25e1f4
 Bump actions/checkout from 5 to 6 (#33) 
Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-11-21 18:19:23 +01:00
.github Bump actions/checkout from 5 to 6 (#33) 2025-11-21 18:19:23 +01: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
build.sh Use NO_COLOR environment variable for doc_status.py (#30) 2025-04-09 15:00:26 +02:00
config.toml Fade out 0/0 completion ratios as there's nothing to document 2020-06-15 21:26:19 +02: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

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.