Doc build crashes

🐛 Bug

Doc build dies. Habitat-sim docs have already been built, m.css is present and accessible in that folder.

Command

(habitat-conda)
dbatra at dbatra-mbp in ~/projects/habitat-api/docs on master
$ ./build-public.sh
Warning: libgs not found
Traceback (most recent call last):
  File "../../habitat-sim/docs/m.css/documentation/python.py", line 2645, in <module>
    run(os.path.dirname(os.path.abspath(args.conf)), config, templates=os.path.abspath(args.templates))
  File "../../habitat-sim/docs/m.css/documentation/python.py", line 2445, in run
    modules_to_crawl += crawl_module(state, path, object)
  File "../../habitat-sim/docs/m.css/documentation/python.py", line 670, in crawl_module
    crawl_class(state, subpath, object)
  File "../../habitat-sim/docs/m.css/documentation/python.py", line 408, in crawl_class
    crawl_class(state, subpath, object)
  File "../../habitat-sim/docs/m.css/documentation/python.py", line 383, in crawl_class
    assert id(class_) not in state.crawled
AssertionError

[mosra]

Thanks, this helped very much, was able to localize and fix the assertion. Opened (and immediately merged) https://github.com/facebookresearch/habitat-sim/pull/627, now the docs should build on 3.6 again.

[dhruvbatra]

[Making my way through the various PRs/issues on this]

Yes, docs for h-api (master) with h-sim (master) now build. There’s still an error in there, but it appears unrelated, so I’ll close this issue and move onto others. Thanks @mosra.

dbatra at dbatra-mbp in ~/projects/habitat-api/docs on master
$ ./build-public.sh 
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.config.get_config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.env.Env.__init__), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.env.Env.reconfigure), possibly hidden/undocumented?
WARNING:root:habitat.core.env.Env.step(self, action: typing.Union[int, str, typing.Dict[str, typing.Any]], kwargs) parameter kwargs is not documented
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.env.RLEnv.__init__), possibly hidden/undocumented?
WARNING:root:habitat.core.embodied_task.Action.step(self, args: typing.Any, kwargs: typing.Any) parameter args is not documented
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.embodied_task.EmbodiedTask.__init__), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.embodied_task.EmbodiedTask.overwrite_sim_config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.embodied_task.EmbodiedTask.overwrite_sim_config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.embodied_task.SimulatorTaskAction.__init__), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.dataset.Dataset.get_scenes_to_load), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.ActionSpaceConfiguration.__init__), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.ActionSpaceConfiguration.config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.BumpSensor.config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.DepthSensor.config), possibly hidden/undocumented?
WARNING:root:habitat.core.simulator.Observations.__init__(self, sensors: typing.Dict[str, habitat.core.simulator.Sensor], args: typing.Any, kwargs: typing.Any) parameter args is not documented
WARNING:root:habitat.core.simulator.Observations.__init__(self, sensors: typing.Dict[str, habitat.core.simulator.Sensor], args: typing.Any, kwargs: typing.Any) parameter kwargs is not documented
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.RGBSensor.config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.SemanticSensor.config), possibly hidden/undocumented?
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.Sensor.config), possibly hidden/undocumented?
<string>:1: (ERROR/3) Error in "py:function" directive:
invalid option block.

.. py:function:: habitat.core.simulator.Simulator.geodesic_distance
    :summary: Calculates geodesic distance between two points.
    :param position_a: coordinates of first point.
    :param position_b: coordinates of second point or list of goal points
    coordinates.
    :param episode: The episode with these ends points.  This is used for shortest path computation caching
    :return:
        the geodesic distance in the cartesian space between points
        :p:`position_a` and :p:`position_b`, if no path is found between
        the points then `math.inf` is returned.


ERROR:root:Failed to process a docstring for habitat.core.simulator.Simulator.geodesic_distance, ignoring:
 | Calculates geodesic distance between two points.
 | 
 | :param position_a: coordinates of first point.
 | :param position_b: coordinates of second point or list of goal points
 | coordinates.
 | :param episode: The episode with these ends points.  This is used for shortest path computation caching
 | :return:
 |     the geodesic distance in the cartesian space between points
 |     :p:`position_a` and :p:`position_b`, if no path is found between
 |     the points then `math.inf` is returned.

WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.simulator.Simulator.reconfigure), possibly hidden/undocumented?
WARNING:root:habitat.core.simulator.Simulator.step(self, action, args, kwargs) parameter args is not documented
WARNING:root:habitat.core.simulator.Simulator.step(self, action, args, kwargs) parameter kwargs is not documented
WARNING:root:habitat.core.registry.Registry.register_action_space_configuration(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_dataset(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_measure(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_sensor(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_simulator(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_task(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_task_action(to_register, name: typing.Optional[str]) parameter to_register is not documented
WARNING:root:habitat.core.registry.Registry.register_task_action(to_register, name: typing.Optional[str]) documents parameter action_space, which isn't in the signature
WARNING:root:could not resolve a link to habitat.config.default.Config which is among INPUT_MODULES (referred from habitat.core.vector_env._make_env_fn), possibly hidden/undocumented?
------------------------------------------------------------------------
Public docs were successfully generated to the following location. Note
that the search functionality requires a web server in this case.