Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md in docs #2412

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: texlive

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
```

or on OSX :
```
brew install --cask mactex
Expand All @@ -26,13 +43,26 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi
```

### Building Docs:
For Ubuntu:
```bash
python setup.py build_ext --inplace
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did this not work for you? I think this worked for me last time.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't work for me, for some reason I had to go to the root and run ./build.sh, then go back down to the docs folder.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. I agree you can do the source build this way to get a similar result, but the inplace build should do it and worked for me in the past.

cd docs
git submodule update --init
./build.sh # or ./build-public.sh when deploying to aihabitat.org
```

For Fedora:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The steps should be the same for Ubuntu and Fedora.

```bash
cd docs
git submodule update --init

cd habitat-sim
./build.sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may need --with-bullet to compile the physics libraries in order for their docstrings to be available after building the docs

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That might be it. My method somehow make the "magnum" part load, maybe that was the physics libraries.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Magnum will load either way, but some parts of the code are compiled out when bullet isn't included.


cd docs
./build.sh
```

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

```bash
Expand Down