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

failed building docs locally #1533

Closed
maominzhe opened this issue Oct 11, 2021 · 2 comments
Closed

failed building docs locally #1533

maominzhe opened this issue Oct 11, 2021 · 2 comments

Comments

@maominzhe
Copy link

Habitat-Sim version

v0.2.1

❓ Questions and Help

I got a problem when I'm following the instruction on building docs locally, it returns the following error when I run ./build.sh:

Warning: libgs not found
warning: ignoring unsupported tag 'HTML_FORMULA_FORMAT' at line 1504, file Doxyfile
warning: ignoring unsupported tag 'FORMULA_MACROFILE' at line 1530, file Doxyfile
..........
User/habitat-sim/src/esp/physics/RigidBase.h:102: warning: unable to resolve reference to 'Rigid' for \ref command
User/habitat-sim/src/esp/physics/RigidObject.h:113: warning: The following parameters of esp::physics::RigidObject::initialize(const assets::ResourceManager &resMgr, const assets::AbstractPhysicsAttributes::ptr physicsAttributes) are not documented:
parameter 'resMgr'
........
File "conf.py", line 17, in
import habitat_sim # NOQA
File "../habitat_sim/init.py", line 14, in
from habitat_sim.nav import *
File "../habitat_sim/nav/init.py", line 1, in
from habitat_sim._ext.habitat_sim_bindings import (
ModuleNotFoundError: No module named 'habitat_sim._ext'

I followed the suggestions from #491 but it didn't work.
echo $(cd examples; python -c "import habitat_sim; print(habitat_sim.__file__)")
shows
(habitat) ➜ docs git:(020041d7) python -c "import habitat_sim;print(habitat_sim.__file__)" /Users/maomao/opt/anaconda3/envs/habitat/lib/python3.6/site-packages/habitat_sim-0.1.5-py3.6-macosx-10.9-x86_64.egg/habitat_sim/__init__.py

I also tried unset PYTHONPATH

Any help on how to solve this? much much thanks!

@Skylion007
Copy link
Contributor

Skylion007 commented Oct 11, 2021

PYTHONPATH=.:${PYTHONPATH} should add your current directory to the Python path. (If you are using build.sh, it should be pointing the local habitat_sim and not the one installed to your site-package.)

@erikwijmans
Copy link
Contributor

erikwijmans commented Oct 12, 2021

The docs require a local build, i.e. run ./build.sh outside the docs folder first, IIRC as we don't ship the doxygen files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants