From 1468f35d23a5374ff9c359ac45a1c0dbe951c704 Mon Sep 17 00:00:00 2001 From: danieltmeta <165730994+danieltmeta@users.noreply.github.com> Date: Thu, 20 Jun 2024 19:10:46 -0700 Subject: [PATCH 1/3] Update README.md in docs This PR is to update the installation instructions for the doc folder for html documentation reference. --- docs/README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/docs/README.md b/docs/README.md index e6f192e978..eb6f6ac571 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,27 @@ ## Building Docs Locally ### First Time Setup: +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 Fedora Linux : ``` -sudo apt install --allow-change-held-packages \ - texlive-base \ - texlive-latex-extra \ - texlive-fonts-extra \ - texlive-fonts-recommended +sudo dnf install texlive-scheme-full ``` + or on OSX : ``` brew install --cask mactex @@ -27,10 +34,14 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi ### Building Docs: ```bash -python setup.py build_ext --inplace cd docs git submodule update --init -./build.sh # or ./build-public.sh when deploying to aihabitat.org + +cd habitat-sim +./build.sh + +cd docs +./build.sh ``` If you're having trouble with doxygen, check your version with From 418ae31bce6e5abfa9388b30bf1acceb443253f2 Mon Sep 17 00:00:00 2001 From: danieltmeta <165730994+danieltmeta@users.noreply.github.com> Date: Fri, 21 Jun 2024 15:36:53 -0700 Subject: [PATCH 2/3] Update docs/README.md Co-authored-by: Alexander Clegg --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index eb6f6ac571..56918367c7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ ## Building Docs Locally ### First Time Setup: -Create a new conda environment: +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 From e3f47b63e75bee8d6b13f6d4a0bc20d08cd9c4cc Mon Sep 17 00:00:00 2001 From: danieltmeta <165730994+danieltmeta@users.noreply.github.com> Date: Fri, 21 Jun 2024 23:01:14 +0000 Subject: [PATCH 3/3] Change Readme.md after comments from Alex --- docs/README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 56918367c7..7c420a4f17 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,7 +17,17 @@ 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 textlive on Fedora Linux : +To build the docs, you will also need to install textlive. +On Ubuntu: +``` +sudo apt install --allow-change-held-packages \ + texlive-base \ + texlive-latex-extra \ + texlive-fonts-extra \ + texlive-fonts-recommended +``` + +On Fedora Linux : ``` sudo dnf install texlive-scheme-full ``` @@ -33,6 +43,15 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi ``` ### Building Docs: +For Ubuntu: +```bash +python setup.py build_ext --inplace +cd docs +git submodule update --init +./build.sh # or ./build-public.sh when deploying to aihabitat.org +``` + +For Fedora: ```bash cd docs git submodule update --init