ENH: Add documentation build GHA workflow file #57
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
jhlegarreta
force-pushed
the
AddDocBuildGHAWorkflow
branch
from
e29e04d to
c77c7c2
Compare
Add documentation build GHA workflow file.
jhlegarreta
force-pushed
the
AddDocBuildGHAWorkflow
branch
from
c77c7c2 to
c444f69
Compare
Make the documentation config file `latex_preamble` be a literal string:
add the `r` prefix.
Fixes:
```
File "/home/runner/work/tract_querier/tract_querier/doc/conf.py", line 229
"""
^
SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 1-2: truncated \uXXXX escape
```
raised for example at:
https://github.com/demianw/tract_querier/actions/runs/12170692299/job/33946161700#step:4:15
Provide a class name to the `Sphinx` lexer: the `add_lexer` method does
not accept lexer instances as an argument since version 4.0.
Fixes:
```
Exception occurred:
File ".virtualenvs/tract_querier/lib/python3.10/site-packages/sphinx/highlighting.py", line 159, in get_lexer
lexer = lexer_classes[lang](**opts)
TypeError: 'WMQLLexer' object is not callable
```
raised in a local build with Python 3.10 and Sphinx 8.1.3.
Documentation:
https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_lexer
|
Docs are being built locally: build failures are related to PR #58 will resolve that. 
|
|
Doc build warnings will be addressed as time permits. |
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.
latex_preamblebe a literalSphinxlexer