Support LaTeX minted python blocks #34
Merged
+66
−2
Conversation
This file contains hidden or 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
These are one of the most popular ways to write literal blocks of Python code in LaTeX with syntax colouring.
peterjc
added a commit
to peterjc/biopython
that referenced
this pull request
Dec 6, 2019
This does not cover the pycon (python console) aka doctest style Python snippets in the Tutorial. $ python blacken_docs.py ../biopython/Doc/Tutorial/chapter_*.tex ../biopython/Doc/Tutorial/chapter_advanced.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_align.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_appendix.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_cluster.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_cookbook.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_entrez.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_graphics.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_kegg.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_phylo.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_popgen.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_quick_start.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_seq_annot.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_seqio.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_testing.tex: Rewriting... Note that the black default line length of 88 seems to be OK for the PDF Tutorial output. See adamchainz/blacken-docs#34
|
thanks! |
|
released as 1.4.0 |
peterjc
added a commit
to biopython/biopython
that referenced
this pull request
Dec 11, 2019
This does not cover the pycon (python console) aka doctest style Python snippets in the Tutorial. $ python blacken_docs.py ../biopython/Doc/Tutorial/chapter_*.tex ../biopython/Doc/Tutorial/chapter_advanced.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_align.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_appendix.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_cluster.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_cookbook.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_entrez.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_graphics.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_kegg.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_phylo.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_popgen.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_quick_start.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_seq_annot.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_seqio.tex: Rewriting... ../biopython/Doc/Tutorial/chapter_testing.tex: Rewriting... Note that the black default line length of 88 seems to be OK for the PDF Tutorial output. See adamchainz/blacken-docs#34
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.
Using
\begin{minted}{python}environments is one of the most popular ways to write literal blocks of Python code in LaTeX with syntax colouring.This pull request was written and tested on the Biopython Tutorial, currently written in LaTeX using minted blocks for
pythoncode (and more code usingpyconbut that needs #8 to work), see e.g.https://github.com/biopython/biopython/blob/biopython-175/Doc/Tutorial.tex
We previously used
\verbatimblocks in LaTeX, but these are not specific to Python code and so should not be formatted with black (same issue with RST and::blocks, #21): biopython/biopython@98e84b7The other popular convention for syntax coloured Python code within LaTeX is
\begin{listing}[language=Python]and it would be relatively straightforward to cover that as well.