MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 14 forks source link

Live documentation code blocks do not have syntax highlighting #65

Open simmsa opened 6 months ago

simmsa commented 6 months ago

The current live version of the documentation does not have syntax highlighted code blocks.

Live documentation:

Screenshot 2024-05-16 at 9 22 26 AM

On my local machine I built the documentation with:

nbsphinx==0.9.3
sphinxcontrib-matlabdomain==0.21.4
sphinxcontrib-bibtex==2.6.2
sphinx-rtd-theme==2.0.0

Which was installed with pip install -U sphinxcontrib-bibtex sphinxcontrib-matlabdomain sphinx_rtd_theme nbsphinx per the README. Notably, these versions differ from the listed versions. Some package amongst these includes code block syntax highlighting.

Screenshot 2024-05-16 at 9 22 53 AM

Long term this can be solved by a more consistent Build/CI step. In the short term does it make sense to use the latest versions of the above packages? The docs build properly (at least for me), and the addition of syntax highlighting contributes to an improved user experience.