CEG-TU-Delft/africarain-docs

User documentation for accessing data files from the Africa Rainfall project. Documentation is hosted on readthedocs.io and edits made to the files in this repository will show up on the documentation site. # Africa Rainfall Data documentation User-facing documentation for Africa Rainfall project data. This documentation is hosted at africarain.readthedocs.io. ## Installation: These steps are required to edit files locally and publish to the Read The Docs site. Changes made directly in GitHub via the browser will also be reflected on the readthedocs site after a few minutes. 1. Install Pandoc: pandoc.org 2. Clone the repository ``` shell git clone github.com ``` 3. Go to the root of the repository and create a virtual environment ``` shell $ cd africarain-docs $ python3 -m venv ./venv ``` 4. Activate the virtual environment * Linux: ``` shell $ source ./venv/bin/activate ``` * Windows: ```shell > .\venv\Scripts\activate ``` 5. Use pip to install the required packages ``` shell $ pip install -r requirements.txt ``` 6. Go to `./docs` and compile ``` shell $ make html ``` For more on creating you own Sphinx projects visit the official documentation.