## Building Docs Locally
### First Time Setup:
Install required packages:
```
conda install -c conda-forge doxygen==1.8.16
conda install jinja2 pygments docutils
```

### Building Docs:
```bash
python setup.py install
cd docs
git submodule update --init
./build.sh # or ./build-public.sh when deploying to aihabitat.org
```

If you're having trouble with doxygen, check your version with

```bash
doxygen -v
```

and make sure you're using 1.8.16. 

## Viewing Docs Locally

After a successful build, the `build.sh` script will show clickable links
pointing to the output.  The output for C++ and Python docs is located at:

```
../build/docs-public/habitat-sim/index.html
```

## Docs developer guide

### Doxygen tag files

For Corrade and Magnum, up-to-date tagfiles can be found at
https://magnum.graphics/doc-downloads/; STL tagfile is linked from there as
well.  Update the `docs/corrade.tag`, `docs/magnum.tag` and `docs/stl.tag` with
those. 

For Bullet, the upstream doesn't generate or distribute a tagfile, so it's
needed to build it manually.  The current one is generated from version 2.88 and
was created like this:

```
git clone https://github.com/bulletphysics/bullet3
cd bullet3
git checkout 2.88
nano Doxyfile # modify it to have GENERATE_TAGFILE = bullet.tag
doxygen # it'll complain about some CHM file, ignore that
cp bullet.tag ../habitat-sim/docs/
```
