{"id":20716807,"url":"https://github.com/goostengine/goost-docs","last_synced_at":"2025-06-17T03:38:11.779Z","repository":{"id":49594379,"uuid":"273922829","full_name":"goostengine/goost-docs","owner":"goostengine","description":"Goost official documentation","archived":false,"fork":false,"pushed_at":"2022-05-12T10:24:27.000Z","size":1319,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"gd3","last_synced_at":"2025-03-11T07:28:04.976Z","etag":null,"topics":["godotengine"],"latest_commit_sha":null,"homepage":"https://goost.readthedocs.io/","language":"reStructuredText","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/goostengine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-21T14:40:51.000Z","updated_at":"2021-12-20T18:34:46.000Z","dependencies_parsed_at":"2022-09-06T08:51:27.447Z","dependency_job_id":null,"html_url":"https://github.com/goostengine/goost-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/goostengine/goost-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goostengine%2Fgoost-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goostengine%2Fgoost-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goostengine%2Fgoost-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goostengine%2Fgoost-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/goostengine","download_url":"https://codeload.github.com/goostengine/goost-docs/tar.gz/refs/heads/gd3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/goostengine%2Fgoost-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260286597,"owners_count":22986616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["godotengine"],"created_at":"2024-11-17T03:06:50.104Z","updated_at":"2025-06-17T03:38:11.740Z","avatar_url":"https://github.com/goostengine.png","language":"reStructuredText","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goost documentation\n\n[![Documentation Status](https://readthedocs.org/projects/goost/badge/?version=gd3)](https://goost.readthedocs.io/en/latest/?badge=gd3)\n\nThis repository contains the source files of\n[Goost](https://github.com/goostengine/goost)'s documentation.\n\nSee [Godot Engine Documentation](https://github.com/godotengine/godot-docs)\nfor existing documentation writing workflow and other instructions.\n\n## Goost-specific instructions\n\n### Building documentation\n\nDocumentation can be built using the same tool which builds Godot Engine:\n```\nscons\n```\n\nThis will build `html` pages by default as seen in the\n[Goost documentation](https://goost.readthedocs.io/en/latest/).\n\nIf you'd like to build documentation in other formats supported by Sphinx, \nrun `scons --help` to retrieve a list of all supported build targets.\n\nFor instance, to build a single large HTML file:\n\n```\nscons target=singlehtml\n```\n\n### Generating class reference\n\nThe following assumes that you compile Goost with the `scons` option, so that\nGodot repository is cloned inside Goost repository (default behavior):\n\n```\ncd goost\npython goost.py --generate-doc-api \"/path/to/goost-docs/classes\"\n```\n\nThe above will generate the class reference using Godot's `makerst` tool\nautomatically, along with Goost components information included in\n`components/`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoostengine%2Fgoost-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoostengine%2Fgoost-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoostengine%2Fgoost-docs/lists"}