{"id":18302277,"url":"https://github.com/polyhedraldev/terradocs","last_synced_at":"2025-04-05T14:31:28.140Z","repository":{"id":38126127,"uuid":"441118766","full_name":"PolyhedralDev/TerraDocs","owner":"PolyhedralDev","description":"Documentation for Terra's API and core config schemas","archived":false,"fork":false,"pushed_at":"2025-03-11T18:54:58.000Z","size":123873,"stargazers_count":7,"open_issues_count":15,"forks_count":9,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-21T05:43:09.247Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://terra.polydev.org/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PolyhedralDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-23T08:49:35.000Z","updated_at":"2025-03-11T18:54:11.000Z","dependencies_parsed_at":"2025-02-28T00:44:24.739Z","dependency_job_id":null,"html_url":"https://github.com/PolyhedralDev/TerraDocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyhedralDev%2FTerraDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyhedralDev%2FTerraDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyhedralDev%2FTerraDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyhedralDev%2FTerraDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PolyhedralDev","download_url":"https://codeload.github.com/PolyhedralDev/TerraDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247352623,"owners_count":20925305,"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":[],"created_at":"2024-11-05T15:18:49.337Z","updated_at":"2025-04-05T14:31:23.121Z","avatar_url":"https://github.com/PolyhedralDev.png","language":"CSS","readme":"# Terra Docs\n\nDocumentation for [Terra](https://github.com/PolyhedralDev/Terra/).\n\nBased on [Sponge](https://github.com/SpongePowered/SpongeDocs)'s documentation tooling.\n\n## Local Usage\n\n## Set up\n\n1. Clone this project locally.\n2. Ensure installed:\n   * Python 3.4+ for Sphinx and its dependencies.\n   * Node.js \u0026 npm for gulp and its dependencies.\n   * [Graphviz](https://graphviz.org/download/) for rendering diagrams.\n3. Open project directory in a terminal\n4. Set up python virtual environment (optional, recommended - if you want to install dependencies local rather than system-wide):\n   * Run `python -m venv .venv` to create the virtual environment.\n   * Activate the virtual environment, this depends on your system setup:\n       * **Bash** - run `source .venv/bin/activate`\n       * **Other setups** see [python documentation](https://docs.python.org/3/library/venv.html#how-venvs-work).\n   * To leave the virtual environment in your shell, simply run `deactivate`\n5. Install python packages\n   * If you already have `pip` installed or are using a virtual environment run `pip install -r requirements.txt`\n   * Otherwise run `python -m pip install -r requirements.txt`\n       * Windows users: If you see a WARNING about adding the \\Scripts folder to PATH, do it, then restart terminal.\n   gulp\n6. Install Node.js packages to project directory.\n   * Run `npm install`\n\n### Running\n\n1. Open project directory in a terminal.\n2. If you are using a virtual environment, make sure to activate it first (see step 4).\n3. Run `npm exec gulp`\n\nGulp will open a browser window displaying the HTML generated by Sphinx for the reStructuredText documentation.\nChanges made to documentation sources will automatically update the browser view.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyhedraldev%2Fterradocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolyhedraldev%2Fterradocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolyhedraldev%2Fterradocs/lists"}