idaholab / HERON

Holistic Energy Resource Optimization Network (HERON) is a modeling toolset and plugin for RAVEN to accelerate stochastic technoeconomic assessment of the economic viability of various grid-energy system configurations, especially with application to electrical grids and integrated energy systems (IES).
Apache License 2.0
24 stars 38 forks source link

[DEFECT] Documentation is failing to build on MacOS #184

Closed AnthoneyGriffith closed 2 years ago

AnthoneyGriffith commented 2 years ago

Defect Description

When running make_docs.sh in the HERON/doc directory, the documentation fails to build and instead yields the following stack trace.

What did you expect to see happen?

The documentation should have built and yielded a pdf in an adjacent directory.

What did you see instead?
Building manuals ...
... building in user_manual...
Traceback (most recent call last):
  File "script/generate_user_manual.py", line 9, in <module>
    import collect_tex
  File "/Users/grifaa/Documents/projects/HERON/doc/user_manual/script/collect_tex.py", line 15, in <module>
    import Cases, Components, Placeholders
  File "/Users/grifaa/Documents/projects/HERON/src/Cases.py", line 15, in <module>
    from HERON.src.base import Base
ModuleNotFoundError: No module named 'HERON'
make: *** [populate] Error 1
... ... failed to make docs in user_manual
Do you have a suggested fix for the development team?

Fix the import in the generate_user_manual.py file.

Describe how to Reproduce Steps to reproduce the behavior:

  1. Change to directory HERON/doc
  2. run make_docs.sh

Screenshots and Input Files Please attach the input file(s) that generate this error. The simpler the input, the faster we can find the issue.

Platform (please complete the following information):


For Change Control Board: Issue Review

This review should occur before any development is performed as a response to this issue.


For Change Control Board: Issue Closure

This review should occur when the issue is imminently going to be closed.

dgarrett622 commented 2 years ago

Fixed by #185