Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fslit seems to no longer work very well #117

Open
msprotz opened this issue Mar 13, 2020 · 6 comments
Open

fslit seems to no longer work very well #117

msprotz opened this issue Mar 13, 2020 · 6 comments

Comments

@msprotz
Copy link
Contributor

msprotz commented Mar 13, 2020

Looking at https://fstarlang.github.io/lowstar/html/LowStar.html#some-valid-low-constructs it appears that code blocks for F* are no longer rendered properly

Thanks,

Jonathan

@cpitclaudel
Copy link
Contributor

Do you know what changed (a sphinx update maybe?)

@msprotz
Copy link
Contributor Author

msprotz commented Mar 16, 2020

no we pinned sphinx to the previous version -- I'm observing this with my local machine:

jonathan@absinthe:~/Code/mitls-fstar (no_hsl) $ sphinx-build --version
sphinx-build 2.4.3

and also on the CI build

jonathan@absinthe:~/Code/everest-ci (master) $ git grep sphinx
server-infra/linux/.docker/Dockerfile:#Install sphinx (for the Low* tutorial)
server-infra/linux/.docker/Dockerfile:RUN pip3 install sphinx==1.7.2 sphinx_rtd_theme

@cpitclaudel
Copy link
Contributor

Maybe sphinx_rtd_theme, then? Can you try pinning it to a previous release and seeing if that still happens?

@msprotz
Copy link
Contributor Author

msprotz commented Mar 16, 2020

indeed, it looks like sphinx_rtd_theme now slaps white-space: nowrap on <code> HTML tags

any way you could skip the <code> tag? right now the structure is

<pre>
<code>stuff
over
multiple
lines but with white-space nowrap
</code>
</pre>

the <pre>, per sphinx-rtd-theme, has the right CSS styling so just getting rid of the extra <code> would likely be enough

@msprotz
Copy link
Contributor Author

msprotz commented Mar 16, 2020

actually, is there any way that fslit could generate the equivalent of


.. code-block:: fstar
  <contents of the F* code here>

? I'm enjoying syntax higlighting via pygments for code-blocks I manually wrote, but the fslit-generated code blocks don't seem to be enjoying this formatting

@cpitclaudel
Copy link
Contributor

Sorry, I missed your messages. I'd use a custom stylesheet to work around this problem; let me know if you need help writing it.

actually, is there any way that fslit could generate the equivalent of …

Yes, definitely; the reason they are not currently highlighted is that they're intended to be highlighted in js, along with running fstar.js.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants