[Docs] Fix highlighting and always use latest packages #11662
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cameel
force-pushed
the
docs-fix-highlighting-and-upgrade-pygments
branch
from
d72e713
to
e15a86d
Compare
cameel
commented
Jul 14, 2021
| pip3 install -r requirements.txt | ||
| pip3 install -r requirements.txt --upgrade --upgrade-strategy eager |
There was a problem hiding this comment.
This is the whole point of the PR. Default upgrade strategy is only-if-needed so if an older package happens to be already installed and fits the requirements but a newer version is also available, pip keeps the older one.
Looks like we install the outdated python3-sphinx ourselves in the Ubuntu image. I think we can safely remove it from there.
cameel
commented
Jul 14, 2021
Comment on lines
-1266
to
1269
| :: | ||
| .. code-block:: none | ||
|
|
||
| for { ... } 1 { ... } { | ||
| if iszero(c) { break } |
There was a problem hiding this comment.
I tried to use yul with :force: for this but I can't because we try to compile all yul snippets in cmdlineTests.sh and these obviously won't compile.
…g unable to process the former
cameel
force-pushed
the
docs-fix-badly-indented-lists-and-blocks
branch
from
76bbd45
to
b513ca1
Compare
cameel
force-pushed
the
docs-fix-highlighting-and-upgrade-pygments
branch
from
e15a86d
to
0f7a185
Compare
This was referenced Jul 16, 2021
Base automatically changed from
docs-fix-badly-indented-lists-and-blocks
to
develop
July 21, 2021 16:35
leonardoalt
approved these changes
Jul 29, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #11660 (I put whitespace changes in a separate PR because they add tons of noise).
The main point of this PR is to make
b_docsjob in CI use latest versions of Python packages, in particularPygments. Locally I get a lot of errors from the highlighter but they do not appear in CI. Turns out it's because the image we use (solbuildpackpusher/solidity-buildpack-deps:ubuntu2004-6) has an old version of Sphinx with its dependencies in it andpipby default does not update a package unless it absolutely has to.To be able to do this I had to fix these highlighting errors though. Looks like the lexer has a lot of problems parsing fairly mundane stuff like
&&,||,? :,1e18orpragma solidity >x.y.z;. In case of pragmas I fixed it by switching to>=but for others I just had to use:force:to make it continue despite errors. This is the same thing I noticed withassemblyblocks in #11420.pygments-lexer-soliditydoes not seem actively maintained so we'll probably have to fix it ourselves eventually.While doing it I also found some
::style blocks, apparently missed in #11477 so I converted them. Some existing blocks were also labeled with wrong language. Finally, I enabled highlighting for some of our JSON blocks (especially the Standard JSON input/output). They did have some syntax errors I had to fix (missing commas or quotes) and also I highlight them asjavascriptrather thanjsonbecause comments are technically not valid in JSON and the highliter does not accept them.