{"id":20915793,"url":"https://github.com/brainelectronics/rtd-tutorial-template","last_synced_at":"2026-04-29T03:33:16.314Z","repository":{"id":69601914,"uuid":"556413436","full_name":"brainelectronics/rtd-tutorial-template","owner":"brainelectronics","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-17T17:05:14.000Z","size":42,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-19T16:24:36.773Z","etag":null,"topics":["read-the-docs","rtd","template","test"],"latest_commit_sha":null,"homepage":"","language":"Python","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/brainelectronics.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","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":"2022-10-23T19:49:46.000Z","updated_at":"2022-10-23T19:51:32.000Z","dependencies_parsed_at":"2023-05-31T12:00:54.504Z","dependency_job_id":null,"html_url":"https://github.com/brainelectronics/rtd-tutorial-template","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"readthedocs/tutorial-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Frtd-tutorial-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Frtd-tutorial-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Frtd-tutorial-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brainelectronics%2Frtd-tutorial-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brainelectronics","download_url":"https://codeload.github.com/brainelectronics/rtd-tutorial-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243307490,"owners_count":20270264,"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":["read-the-docs","rtd","template","test"],"created_at":"2024-11-18T16:18:23.322Z","updated_at":"2025-12-30T04:18:00.013Z","avatar_url":"https://github.com/brainelectronics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Template for the Read the Docs tutorial\n\n[![Documentation Status](https://readthedocs.org/projects/brainelectronics-tutorial-template/badge/?version=latest)](https://brainelectronics-tutorial-template.readthedocs.io/en/latest/?badge=latest)\n![Release](https://img.shields.io/github/v/release/brainelectronics/rtd-tutorial-template?include_prereleases\u0026color=success)\n![Python](https://img.shields.io/badge/python3-Ok-green.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nExample RTD template project\n\n---------------\n\nThis GitHub template includes fictional Python library\nwith some basic Sphinx docs.\n\nThe created documentation can be found at\n\nhttps://brainelectronics-tutorial-template.readthedocs.io/en/latest/\n\n\u003c!-- MarkdownTOC --\u003e\n\n- [Getting started](#getting-started)\n\t- [Install required tools](#install-required-tools)\n\t- [Create documentation](#create-documentation)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n## Getting started\n\n### Install required tools\n\nPython3 must be installed on your system. Check the current Python version\nwith the following command\n\n```bash\npython --version\npython3 --version\n```\n\nDepending on which command `Python 3.x.y` (with x.y as some numbers) is\nreturned, use that command to proceed.\n\n```bash\n# create and activate virtual environment\npython3 -m venv .venv\nsource .venv/bin/activate\n\n# install and upgrade required packages\npip install -U -r docs/requirements.txt\n```\n\n### Create documentation\n\n```bash\n# perform link checks\nsphinx-build docs/ docs/build/linkcheck -d docs/build/docs_doctree/ --color -blinkcheck -j auto -W\n\n# create documentation\nsphinx-build docs/ docs/build/html/ -d docs/build/docs_doctree/ --color -bhtml -j auto -W\n```\n\nThe created documentation can be found [here](docs/build/html).\n\nErrors thrown due to invalid `autosectionlabels` or by invalid references to\nfiles not being part of the [`docs/`](docs) folder are ignored, see\n[`suppress_warnings` in docs config](docs/config.py)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrainelectronics%2Frtd-tutorial-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrainelectronics%2Frtd-tutorial-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrainelectronics%2Frtd-tutorial-template/lists"}