diff --git a/docs/README.md b/docs/README.md index e6f192e978..7c420a4f17 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,13 +1,24 @@ ## Building Docs Locally ### First Time Setup: +If a conda environment for habitat does not already exist, create a new conda environment: + +```bash +# We require python>=3.9 and cmake>=3.10 +conda create -n habitat python=3.9 cmake=3.14.0 +conda activate habitat +``` + Install required packages: ``` -conda install -c conda-forge doxygen==1.8.16 -conda install jinja2 pygments docutils +cd habitat-sim +pip install -r requirements.txt --progress-bar off +pip install imageio imageio-ffmpeg +conda install -y -c conda-forge doxygen=1.9.5 +conda install -y jinja2 pygments docutils ``` -To build the docs, you will also need to install the following -packages on Linux : +To build the docs, you will also need to install textlive. +On Ubuntu: ``` sudo apt install --allow-change-held-packages \ texlive-base \ @@ -15,6 +26,12 @@ sudo apt install --allow-change-held-packages \ texlive-fonts-extra \ texlive-fonts-recommended ``` + +On Fedora Linux : +``` +sudo dnf install texlive-scheme-full +``` + or on OSX : ``` brew install --cask mactex @@ -26,6 +43,7 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi ``` ### Building Docs: +For Ubuntu: ```bash python setup.py build_ext --inplace cd docs @@ -33,6 +51,18 @@ git submodule update --init ./build.sh # or ./build-public.sh when deploying to aihabitat.org ``` +For Fedora: +```bash +cd docs +git submodule update --init + +cd habitat-sim +./build.sh + +cd docs +./build.sh +``` + If you're having trouble with doxygen, check your version with ```bash