{"id":23116426,"url":"https://github.com/3dcitydb/3dcitydb-docs","last_synced_at":"2025-08-16T21:32:50.794Z","repository":{"id":40510871,"uuid":"177880612","full_name":"3dcitydb/3dcitydb-docs","owner":"3dcitydb","description":"User manual of the 3D City Database and tools","archived":false,"fork":false,"pushed_at":"2024-11-20T09:53:50.000Z","size":172648,"stargazers_count":20,"open_issues_count":2,"forks_count":11,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-12-15T10:46:53.704Z","etag":null,"topics":["3dcitydb","citygml","database","manual","readthedocs","sphinx-documentation","user-guide"],"latest_commit_sha":null,"homepage":"http://3dcitydb-docs.rtfd.io/ ","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/3dcitydb.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}},"created_at":"2019-03-26T22:54:08.000Z","updated_at":"2024-09-19T18:37:44.000Z","dependencies_parsed_at":"2024-09-15T13:21:25.583Z","dependency_job_id":null,"html_url":"https://github.com/3dcitydb/3dcitydb-docs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2F3dcitydb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2F3dcitydb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2F3dcitydb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2F3dcitydb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3dcitydb","download_url":"https://codeload.github.com/3dcitydb/3dcitydb-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230061427,"owners_count":18166705,"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":["3dcitydb","citygml","database","manual","readthedocs","sphinx-documentation","user-guide"],"created_at":"2024-12-17T04:16:10.228Z","updated_at":"2025-08-16T21:32:50.784Z","avatar_url":"https://github.com/3dcitydb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 3D City Database User Manual\n\n\u003e [!NOTE]\n\u003e This repository hosts the 3DCityDB v4 user manual. Although 3DCityDB v5 is now available, 3DCityDB v4\n\u003e remains stable and operational. However, it is in **maintenance mode**, meaning no significant new features are\n\u003e planned, though existing bugs will continue to be addressed. Development is now focused on 3DCityDB v5, and we recommend\n\u003e upgrading to benefit from new features and improvements. Please refer to the [3DCityDB v5 user manual](https://3dcitydb.github.io/3dcitydb-mkdocs/)\n\u003e for more information.\n\nThe 3DCityDB User Manual is built and hosted on [ReadTheDocs.org](https://readthedocs.org).\nPlease use the link below to find the online version of this documentation.\n\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e:arrow_right: http://3dcitydb-docs.rtfd.io/ :arrow_left:\u003c/p\u003e\n\u003cbr/\u003e\n\n![cover_image](source/media/cover_image.png)\n\nThe images on the cover page were provided by:\n\n- Chair of Photogrammetry and Remote Sensing \u0026 Chair of Cartography, Technische Universität München\n\n- Geobasisdaten: © Stadtvermessung Frankfurt am Main\n\n- IDAC Ltd, UK.\n\n- Virtual City Systems, Berlin, Germany\n\n- Chair of Geoinformatics, Technische Universität München. Image created based on master thesis work of Matthias Körner, jointly supervised with HTW Dresden\n\n- 3D City Model of Berlin © Berlin Partner GmbH\n\n- M.O.S.S. Computer Grafik Systeme GmbH, Taufkirchen, Germany\n\n## How to build this documentation\n\n### Build with Docker\n\nTo avoid setting up the build environment, it is recommended to use [Docker](https://docs.docker.com/get-docker/)\nand [this Docker image](https://github.com/BWibo/sphinx-rtd-docker) to build this documentation.\n\n#### Build process\n\n1. Clone this repo and navigate to the repo folder:\n\n   ```bash\n   git clone https://github.com/3dcitydb/3dcitydb-docs.git\n   cd 3dcitydb-docs\n   ```\n\n2. Mount the current directory to the images `/docs` folder and build the HTML version:\n\n    ```bash\n    docker run --rm \\\n      -v $PWD:/docs \\\n    bwibo/sphinx-rtd make html\n    ```\n\n3. The build files are in `build/html`.\n\n### Build in a local Python environment\n\nTo build this documentation following tools are required:\n\n- Python 3.6+: \u003chttps://www.python.org/\u003e\n- Sphinx: \u003chttps://www.sphinx-doc.org/en/master/usage/installation.html\u003e\n- Sphinx ReadTheDocs Theme: \u003chttps://sphinx-rtd-theme.readthedocs.io/en/stable/\u003e\n- Sphinx copybutton: \u003chttps://sphinx-copybutton.readthedocs.io/en/latest/\u003e\n\nRun this to install all dependencies in an existing Python environment using\n[pip](https://packaging.python.org/tutorials/installing-packages/https://packaging.python.org/tutorials/installing-packages/):\n\n```python\npip install -U sphinx\npip install -U -r source/requirements.txt\n```\n\n#### Build process\n\n1. Clone this repo and navigate to the repo folder:\n\n   ```bash\n   git clone https://github.com/3dcitydb/3dcitydb-docs.git\n   cd 3dcitydb-docs\n   ```\n\n2. Build the HTML version of the documentation:\n\n   - Linux:\n\n      ```bash\n      make html\n      ```\n\n      **Note:** If `make` is not available on your system, you can get it from\n      packages:\n\n        - Debian based Linux: `apt-get install make` or `apt-get install build-essential`.\n        - Alpine Linux: `apk add make` or `apk add alpine-sdk`.\n\n   - Windows:\n\n      ```cmd\n      make.bat html\n      ```\n\n3. The build files are in `build/html`.\n\n## Documentations of previous versions\n\nDocumentations of previous versions are available as PDF here:\n\u003chttps://www.3dcitydb.org/3dcitydb/documentation/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3dcitydb%2F3dcitydb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3dcitydb%2F3dcitydb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3dcitydb%2F3dcitydb-docs/lists"}