An open API service indexing awesome lists of open source software.

https://github.com/dimagi/commcare-analytics-ansible

Ansible tool for superset server deployment
https://github.com/dimagi/commcare-analytics-ansible

Last synced: 5 months ago
JSON representation

Ansible tool for superset server deployment

Awesome Lists containing this project

README

          

CommCare Analytics Ansible
==========================

Tools for setting up and deploying a Commcare Analytics server.

Documentation
-------------

The documentation in the `docs/` directory is hosted on [Read the Docs](https://commcare-analytics-ansible.readthedocs.io/en/latest/).

## Building the docs

To build the docs locally,

1. Clone this repository, and change into the directory.

2. Create and activate a virtual environment
```shell
$ python3 -m venv venv
$ source venv/bin/activate
```

3. Install requirements:
```shell
$ pip install -r requirements/docs-requirements.txt
```

4. Change into the docs/ directory, and build the docs in HTML
```shell
$ cd docs/
$ make html
```

5. To serve the docs locally, you can use Python's webserver:
```shell
$ cd _build/html/
$ python -m http.server 9000
$ firefox 'http://localhost:9000/'
```

Alternatively, open `_build/html/index.html` in a browser:
```shell
$ firefox _build/html/index.html
```