emrgnt-cmplxty/automata

Discrepancy in Naming of Sphinx Dependencies

Closed this issue · 0 comments

Describe the bug
In the current configuration of our requirements.txt, the dependencies for Sphinx are listed as sphinx-panels and sphinx-rtd-dark-mode. However, on a Windows system, these dependencies are installed and imported with underscores rather than hyphens, specifically as sphinx_panels and sphinx_rtd_dark_mode.

To Reproduce
This discrepancy can be observed when attempting to install the dependencies on a Windows system using pip, as per the instructions in our documentation.

Expected behavior
The dependencies should be correctly listed in requirements.txt such that the installation commands run smoothly across different platforms, including Windows.

Desktop (please complete the following information):

  • OS: Windows 11

Additional context
This issue might lead to confusion or errors when contributors try to set up the project on a Windows system. We need to address this discrepancy and update the requirements.txt to reflect the correct names of the dependencies. Furthermore, it would be beneficial to verify the cross-compatibility of these dependency names across other platforms.