Skip to content

Update README.md in docs #2412

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.

Sign up for GitHub

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

Open
danieltmeta wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update README.md in docs #2412

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1468f35
Update README.md in docs
danieltmeta Jun 21, 2024
418ae31
Update docs/README.md
danieltmeta Jun 21, 2024
e3f47b6
Change Readme.md after comments from Alex
danieltmeta Jun 21, 2024
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
33 changes: 22 additions & 11 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
## Building Docs Locally
### First Time Setup:
Create a new conda environment:
Comment thread
danieltmeta marked this conversation as resolved.
Outdated

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

Comment thread
danieltmeta marked this conversation as resolved.
or on OSX :
```
brew install --cask mactex
Expand All @@ -27,10 +34,14 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi

### Building Docs:
```bash
python setup.py build_ext --inplace

@aclegg3 aclegg3 Jun 21, 2024

Copy link
Copy Markdown
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.

@danieltmeta danieltmeta Jun 21, 2024

Copy link
Copy Markdown
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.

@aclegg3 aclegg3 Jun 24, 2024

Copy link
Copy Markdown
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

cd habitat-sim
./build.sh

@aclegg3 aclegg3 Jun 21, 2024

Copy link
Copy Markdown
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

@danieltmeta danieltmeta Jun 21, 2024

Copy link
Copy Markdown
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.

@aclegg3 aclegg3 Jun 24, 2024

Copy link
Copy Markdown
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
Expand Down