Update README.md in docs #2412
Update README.md in docs #2412
Conversation
This PR is to update the installation instructions for the doc folder for html documentation reference.
| @@ -27,10 +34,14 @@ export PATH=$PATH:/Library/TeX/Distributions/.DefaultTeX/Contents/Programs/texbi | |||
|
|
|||
| ### Building Docs: | |||
| ```bash | |||
| python setup.py build_ext --inplace | |||
There was a problem hiding this comment.
did this not work for you? I think this worked for me last time.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
| ./build.sh # or ./build-public.sh when deploying to aihabitat.org | ||
|
|
||
| cd habitat-sim | ||
| ./build.sh |
There was a problem hiding this comment.
You may need --with-bullet to compile the physics libraries in order for their docstrings to be available after building the docs
There was a problem hiding this comment.
That might be it. My method somehow make the "magnum" part load, maybe that was the physics libraries.
There was a problem hiding this comment.
Magnum will load either way, but some parts of the code are compiled out when bullet isn't included.
Co-authored-by: Alexander Clegg <alexanderwclegg@gmail.com>
| ``` | ||
|
|
||
| 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. |
| ```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: |
There was a problem hiding this comment.
The steps should be the same for Ubuntu and Fedora.
|
Hi @danieltmeta! Thank you for your pull request. We require contributors to sign our Contributor License Agreement, and yours needs attention. You currently have a record in our system, but the CLA is no longer valid, and will need to be resubmitted. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
This PR is to update the installation instructions for the doc folder for html documentation reference.
Motivation and Context
How Has This Been Tested
Types of changes
Checklist