{"id":20885813,"url":"https://github.com/compas-dev/sphinx_compas2_theme","last_synced_at":"2025-06-16T22:35:31.594Z","repository":{"id":212437172,"uuid":"731491233","full_name":"compas-dev/sphinx_compas2_theme","owner":"compas-dev","description":"Sphinx theme for COMPAS 2 based on pydata-sphinx-theme and sphinx-book-theme","archived":false,"fork":false,"pushed_at":"2024-02-09T13:52:35.000Z","size":12648,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-19T01:18:49.388Z","etag":null,"topics":["compas","documentation","sphinx-theme"],"latest_commit_sha":null,"homepage":"http://compas.dev/sphinx_compas2_theme/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compas-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-14T07:49:00.000Z","updated_at":"2024-01-10T22:48:06.000Z","dependencies_parsed_at":"2024-01-18T22:09:08.949Z","dependency_job_id":"72ab8d8c-f9dd-4af3-bc4d-466a85c5bb6b","html_url":"https://github.com/compas-dev/sphinx_compas2_theme","commit_stats":null,"previous_names":["compas-dev/sphinx_compas2_theme"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/compas-dev/sphinx_compas2_theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fsphinx_compas2_theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fsphinx_compas2_theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fsphinx_compas2_theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fsphinx_compas2_theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compas-dev","download_url":"https://codeload.github.com/compas-dev/sphinx_compas2_theme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compas-dev%2Fsphinx_compas2_theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260253321,"owners_count":22981451,"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":["compas","documentation","sphinx-theme"],"created_at":"2024-11-18T08:14:43.419Z","updated_at":"2025-06-16T22:35:31.572Z","avatar_url":"https://github.com/compas-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sphinx Theme for COMPAS 2\n\nThis is a Sphinx theme for COMPAS 2 based on ``pydata-sphinx-theme`` and ``sphinx-book-theme``.\n\n## Getting started with this project\n\n### Setup code editor\n\n1. Open project folder in VS Code\n2. Select python environment for the project\n3. First time using VS Code and on Windows? Make sure select the correct terminal profile: `Ctrl+Shift+P`, `Terminal: Select Default Profile` and select `Command Prompt`.\n\n\u003e All terminal commands in the following sections can be run from the VS Code integrated terminal.\n\n### First steps with git\n\n1. Go to the `Source control` tab\n2. Make an initial commit with all newly created files\n\n### First steps with code\n\n1. Install the newly created project\n\n        pip install -e .\n\n2. Install it on Rhino\n\n        python -m compas_rhino.install\n\n### Code conventions\n\nCode convention follows [PEP8](https://pep8.org/) style guidelines and line length of 120 characters.\n\n1. Check adherence to style guidelines\n\n        invoke lint\n\n2. Format code automatically\n\n        invoke format\n\n### Documentation\n\nDocumentation is generated automatically out of docstrings and [RST](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) files in this repository\n\n1. Generate the docs\n\n        invoke docs\n\n2. Check links in docs are valid\n\n        invoke linkcheck\n\n3. Open docs in your browser (file explorer -\u003e `dist/docs/index.html`)\n\n### Testing\n\nTests are written using the [pytest](https://docs.pytest.org/) framework\n\n1. Run all tests from terminal\n\n        invoke test\n\n2. Or run them from VS Code from the `Testing` tab\n\n### Publish release\n\nReleases follow the [semver](https://semver.org/spec/v2.0.0.html) versioning convention.\n\n1. Create a new release\n\n        invoke release major\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompas-dev%2Fsphinx_compas2_theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompas-dev%2Fsphinx_compas2_theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompas-dev%2Fsphinx_compas2_theme/lists"}