{"id":18858498,"url":"https://github.com/hardwario/doc-tower","last_synced_at":"2026-01-31T13:06:12.217Z","repository":{"id":45986801,"uuid":"301696001","full_name":"hardwario/doc-tower","owner":"hardwario","description":"Documentation for HARDWARIO TOWER","archived":false,"fork":false,"pushed_at":"2022-08-11T06:11:55.000Z","size":162225,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-14T12:13:47.291Z","etag":null,"topics":["doc","hardwario","iot","sphinx","tower"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hardwario.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}},"created_at":"2020-10-06T10:54:12.000Z","updated_at":"2023-01-13T20:17:19.000Z","dependencies_parsed_at":"2022-08-12T12:40:23.545Z","dependency_job_id":null,"html_url":"https://github.com/hardwario/doc-tower","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hardwario/doc-tower","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardwario%2Fdoc-tower","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardwario%2Fdoc-tower/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardwario%2Fdoc-tower/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardwario%2Fdoc-tower/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hardwario","download_url":"https://codeload.github.com/hardwario/doc-tower/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hardwario%2Fdoc-tower/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260528312,"owners_count":23022913,"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":["doc","hardwario","iot","sphinx","tower"],"created_at":"2024-11-08T04:13:41.158Z","updated_at":"2026-01-31T13:06:07.198Z","avatar_url":"https://github.com/hardwario.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Repository: doc-tower\n\nThis repository contains source data for the online datasheet of TOWER. It uses **Sphinx** as a documentation generator altogether with **reStructuredText** as a lightweight markup language.\n\nThe documentation is hosted at [**Read The Docs**](https://readthedocs.org/) and is automatically built on commit to the master branch.\n\nOnce built, the site is available at: **https://tower.hardwario.com/**\n\n---\n**WARNING**\n\nYou should always do ``./docker.sh serve`` before pushing to the master branch and check for any warnings and errors.\n\nEven if the build will succeed it will not show in most major internet browsers.\n\n---\n\n\n## Setup\n\nYou can build your local version of the documentation. All you need is [**Docker Desktop**](https://www.docker.com/products/docker-desktop) and **Git**.\n\nFollow these steps:\n\n1. Open the terminal.\n\n1. Clone the repository:\n\n       git clone https://github.com/hardwario/doc-tower.git\n\n1. Go to the repository:\n\n       cd doc-tower\n\n1. Build the Docker image:\n\n       ./docker.sh build\n\n\n## Usage\n\nGenerate the documentation:\n\n    ./docker.sh generate\n\nThe documentation output is in the directory `build/html/`.\n\nYou can also run the local web server that watches source files for changes and automatically regenerates the documentation:\n\n    ./docker.sh serve\n\nOnce started, the documentation is available at: **http://localhost:5500/**\n\nIf you want to clean the output (contents of the `build/` directory), just use:\n\n    ./docker.sh clean\n\n\n## Editing\n\nThe source files are located in the `source/` directory. Use an editor of your preference.\n\nWe recommend **Visual Studio Code** with these extensions:\n\n* **EditorConfig** (to automatically follow `.editorconfig` file rules)\n* **reStructuredText** (syntax support and highlight for `.rst` files)\n* **Grammarly** (for spelling and grammar check)\n\nAltogether with the `./docker.sh serve` mode, you can have editor and the live browser preview side-by-side.\n\n\n## License\n\nThis project is licensed under the [**Creative Commons Attribution-ShareAlike 4.0 International License**](https://creativecommons.org/licenses/by-sa/4.0/) - see the [**LICENSE**](LICENSE) file for details.\n\n---\n\nMade with ❤️ by [**HARDWARIO a.s.**](https://www.hardwario.com/) in the heart of Europe.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardwario%2Fdoc-tower","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhardwario%2Fdoc-tower","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhardwario%2Fdoc-tower/lists"}