pradyunsg / sphinx-theme-builder

Streamline the Sphinx theme development workflow (maintained, but extremely stable as of Jan 2023)
https://sphinx-theme-builder.rtfd.io/
MIT License
29 stars 17 forks source link

Better document which node is used / how it interacts with existing environments #6

Closed jorisvandenbossche closed 2 years ago

jorisvandenbossche commented 2 years ago

My current understanding is that:

1) It will first check if the "system" node (I suppose what is available if you run node --version in a console on your system) has the exact same version as the required version (node-version in pyproject.toml), and if those match, use the system node. 2) If those version don't match, nodeenv will install the required node version

Is that correct?

But in both cases nodeenv will still create a .nodeenv directory? (only in the first case it seems that the node executable in there is then basically a symlink to the system one. I suppose this is logic that lives in the nodeenv package)

pradyunsg commented 2 years ago

Yup. This package needs a bunch of documentation.

pradyunsg commented 2 years ago

Closing this out for now. This is much easier to explain now, and I'll address this as part of addressing the general lack of documentation.