BCG-X-Official / facet

Human-explainable AI.
https://bcg-x-official.github.io/facet
Apache License 2.0
514 stars 46 forks source link

Isolated Sphinx doc does not build due to missing pytools script #343

Closed ben-howt closed 1 year ago

ben-howt commented 2 years ago

Describe the bug Sphinx doc does not build due to missing pytools script make_base if pytools is not in same parent directory

To Reproduce Steps to reproduce the behavior:

  1. Clone the repo into a separate directory from any pytools clones
  2. Build and activate the conda environment in environment.yml
  3. From the sphinx directory, run python make.py html
  4. See error
Traceback (most recent call last):
  File "make.py", line 30, in <module>
    make()
  File "make.py", line 24, in make
    from make_base import make
ModuleNotFoundError: No module named 'make_base'

Expected behavior Docs should build.

Desktop (please complete the following information):

Additional context Likely this is just a note in contributing.md to make sure that the remotes are all present before trying to build the docs.

j-ittner commented 2 years ago

@ben-howt this is by design, so we can maintain a single make script across all 3 associated repos. Open for alternative suggestions - any ideas how to handle better? Would it be sufficient to explain the approach better in the developer guidelines?

ben-howt commented 2 years ago

Thanks @j-ittner for the response; this makes sense to me as a design decision. I would suggest (and can raise a PR for) the following 2 changes:

j-ittner commented 1 year ago

Addressed by #345