File: README.md

package info (click to toggle)
intake 0.6.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,552 kB
  • sloc: python: 12,408; makefile: 37; sh: 14
file content (37 lines) | stat: -rw-r--r-- 731 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Building Documentation

An environment with several prerequisites is needed to build the
documentation.  Create this with:

## First option for environment

```bash
conda create -n intake python=3.6 pandas dask python-snappy appdirs -c conda-forge -y
conda activate intake
```

Additional pip packages are listed in `./requirements.txt` are required to
build the docs:

```bash
pip install -r requirements.txt
```

## Second option for environment

A conda environment with pip packages included is in `environment.yml` of the current directory, and you may create it with:

```bash
conda env create
conda activate intake
```

## Build docs

To make HTML documentation:

```bash
make html
```

Outputs to `build/html/index.html`