{"id":19216015,"url":"https://github.com/movingblocks/terasologydocs","last_synced_at":"2025-05-12T23:28:47.473Z","repository":{"id":138149822,"uuid":"88088475","full_name":"MovingBlocks/TerasologyDocs","owner":"MovingBlocks","description":null,"archived":false,"fork":false,"pushed_at":"2020-03-22T20:54:13.000Z","size":2805,"stargazers_count":5,"open_issues_count":8,"forks_count":13,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-20T19:38:18.527Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MovingBlocks.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2017-04-12T19:25:58.000Z","updated_at":"2021-09-23T21:18:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"e87cced3-de1e-4502-9757-06d6425c94f9","html_url":"https://github.com/MovingBlocks/TerasologyDocs","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/MovingBlocks%2FTerasologyDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MovingBlocks","download_url":"https://codeload.github.com/MovingBlocks/TerasologyDocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253839597,"owners_count":21972347,"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-09T14:15:32.515Z","updated_at":"2025-05-12T23:28:47.464Z","avatar_url":"https://github.com/MovingBlocks.png","language":"Python","readme":"# Project\n\n[Sphinx](http://www.sphinx-doc.org) based documentation for [Terasology](https://github.com/MovingBlocks/Terasology). Aim of this project is to bundle existing documentation and re-structure it in a more user-friendly way.\n\nThe page of this documentation is available  https://metaterasology.github.io/docs/.\n\n# Contributing\n\nSomething is missing in the docs? Feel free to fork and submit a PR or open an [issue](https://github.com/MovingBlocks/TerasologyDocs/issues).\n\n## Workspace setup\n\nRequires `sphinx`, `sphinx-autobuild`, `javasphinx`, `sphinx_rtd_theme` and `sphinxcontrib.youtube` to be installed (install via python `pip`).\n\n`pip install sphinx sphinx-autobuild javasphinx sphinx_rtd_theme sphinxcontrib.youtube`\n\n**Note** If you are using python3, `pip` will install `sphinx-autobuild` version 0.1.2 which is incompatible with python3. In this case, you might need to download https://github.com/shomah4a/sphinxcontrib.youtube and run `python setup.py install` to install it.  \n\nAny editor for the `.rst` sources is fine, e.g. for Eclipse the [ReST Editor](http://marketplace.eclipse.org/content/rest-editor).\n\n## Build\n\nRunning the server for live-editing: `sphinx-autobuild source build/html` then open [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser.\n\nBuild the page: `sphinx-build -b html source build`.\n\n\n# Page setup\n\nAll page settings are configured in `conf.py`.\n\n## Mapping for the edit-on-github buttons:\n```\nedit_on_github_project = 'MovingBlocks/TerasologyDocs'\nedit_on_github_branch = 'master/source'\n```\n\n## Javadoc location:\n```\njavadoc_url_map = {\n    'org.terasology' : ('http://jenkins.terasology.org/job/Terasology/javadoc/', 'javadoc8')\n}\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fterasologydocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmovingblocks%2Fterasologydocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fterasologydocs/lists"}