Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Enable PowerShell syntax highlighting #14

Open
dustsigns opened this issue Nov 10, 2019 · 5 comments
Open

Enable PowerShell syntax highlighting #14

dustsigns opened this issue Nov 10, 2019 · 5 comments
Assignees
Labels
bug Something isn't working

Comments

@dustsigns
Copy link
Collaborator

According to its documentation, Sphinx is capable of syntax-highlighting PowerShell code. To do so, it requires pygments. According to the latter's documentation, powershell is supported since version 1.5.

However, despite the installation of pygments 2.4.2 inside the docker image (see this commit), syntax highlighting does not work. Sphinx gives the following error message:
sproof-docs-dev_1 | /sphinx-doc/docker/docker-setup.rst:52: WARNING: Could not lex literal_block as "powershell". Highlighting skipped.

PowerShell syntax highlighting is not an absolute must-have, but it is definitively a nice-to-have formatting. Since other languages (e.g., PHP in the API examples) seem to work fine, this should be investigated and fixed.

@dustsigns dustsigns added the bug Something isn't working label Nov 10, 2019
@dustsigns
Copy link
Collaborator Author

Related: The requirements.txt file specifies slightly different versions of the dependencies. They should be made consistent to the Dockerfile.

@cle1000
Copy link
Contributor

cle1000 commented Nov 10, 2019

Related: The requirements.txt file specifies slightly different versions of the dependencies. They should be made consistent to the Dockerfile.

It changed the requirement file.

d85e4f0

@dustsigns
Copy link
Collaborator Author

Thanks, the sphinx_rtd_theme seems to be affected as well. And there are dependencies which are not in both files. Is this deliberate or related to how Read the Docs builds the documentation?

@cle1000
Copy link
Contributor

cle1000 commented Nov 10, 2019

please sign up here: https://readthedocs.org/
after i can add you as a maintainer on the sproof docs project on readthedocs.

@dustsigns
Copy link
Collaborator Author

Done.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants