search

terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality
https://terrapower.github.io/armi/
Apache License 2.0
224 stars 87 forks source link

Typo in docs build instructions #1718

Closed albeanth closed 3 months ago

albeanth commented 3 months ago

While trying to build the docs on my Mac, I came across this install line. https://github.com/terrapower/armi/blob/9ebfe34b93a8040c69868c2199ee6ac6e73652eb/doc/developer/documenting.rst?plain=1#L28

I believe it should be 

pip install -e .[docs,test]

or maybe even just 

pip install -e .[docs]

Otherwise you are missing a bunch of dependencies and have to manually install them.

albeanth commented 3 months ago

After getting the docs to build, there is a non-fatal error for a missing dependency here https://github.com/terrapower/armi/blob/9ebfe34b93a8040c69868c2199ee6ac6e73652eb/armi/utils/gridEditor.py#L54

After running pip install wxPython, said error goes away. So this dep should probably get added to the pyproject.toml file.