https://github.com/3dcitydb/3dcitydb-docs
User manual of the 3D City Database and tools
https://github.com/3dcitydb/3dcitydb-docs
3dcitydb citygml database manual readthedocs sphinx-documentation user-guide
Last synced: 6 months ago
JSON representation
User manual of the 3D City Database and tools
- Host: GitHub
- URL: https://github.com/3dcitydb/3dcitydb-docs
- Owner: 3dcitydb
- License: apache-2.0
- Created: 2019-03-26T22:54:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T09:53:50.000Z (7 months ago)
- Last Synced: 2024-12-15T10:46:53.704Z (6 months ago)
- Topics: 3dcitydb, citygml, database, manual, readthedocs, sphinx-documentation, user-guide
- Language: Python
- Homepage: http://3dcitydb-docs.rtfd.io/
- Size: 165 MB
- Stars: 20
- Watchers: 12
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 3D City Database User Manual
The 3DCityDB User Manual is built and hosted on [ReadTheDocs.org](https://readthedocs.org).
Please use the link below to find the online version of this documentation.
:arrow_right: http://3dcitydb-docs.rtfd.io/ :arrow_left:
The images on the cover page were provided by:
- Chair of Photogrammetry and Remote Sensing & Chair of Cartography, Technische Universität München
- Geobasisdaten: © Stadtvermessung Frankfurt am Main
- IDAC Ltd, UK.
- Virtual City Systems, Berlin, Germany
- Chair of Geoinformatics, Technische Universität München. Image created based on master thesis work of Matthias Körner, jointly supervised with HTW Dresden
- 3D City Model of Berlin © Berlin Partner GmbH
- M.O.S.S. Computer Grafik Systeme GmbH, Taufkirchen, Germany
## How to build this documentation
### Build with Docker
To avoid setting up the build environment, it is recommended to use [Docker](https://docs.docker.com/get-docker/)
and [this Docker image](https://github.com/BWibo/sphinx-rtd-docker) to build this documentation.
#### Build process
1. Clone this repo and navigate to the repo folder:
```bash
git clone https://github.com/3dcitydb/3dcitydb-docs.git
cd 3dcitydb-docs
```
2. Mount the current directory to the images `/docs` folder and build the HTML version:
```bash
docker run --rm \
-v $PWD:/docs \
bwibo/sphinx-rtd make html
```
3. The build files are in `build/html`.
### Build in a local Python environment
To build this documentation following tools are required:
- Python 3.6+:
- Sphinx:
- Sphinx ReadTheDocs Theme:
- Sphinx copybutton:
Run this to install all dependencies in an existing Python environment using
[pip](https://packaging.python.org/tutorials/installing-packages/https://packaging.python.org/tutorials/installing-packages/):
```python
pip install -U sphinx
pip install -U -r source/requirements.txt
```
#### Build process
1. Clone this repo and navigate to the repo folder:
```bash
git clone https://github.com/3dcitydb/3dcitydb-docs.git
cd 3dcitydb-docs
```
2. Build the HTML version of the documentation:
- Linux:
```bash
make html
```
**Note:** If `make` is not available on your system, you can get it from
packages:
- Debian based Linux: `apt-get install make` or `apt-get install build-essential`.
- Alpine Linux: `apk add make` or `apk add alpine-sdk`.
- Windows:
```cmd
make.bat html
```
3. The build files are in `build/html`.
## Documentations of previous versions
Documentations of previous versions are available as PDF here: