mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Suppress Sphinx lexer warnings in frontends.rst 

Because some of the JSON blocks in frontends.rst included non-JSON
contents (user replies, etc.) the blocks didn't parse/highlight and
`make html` complained:

borg/docs/internals/frontends.rst:28: WARNING: Could not lex literal_block as "json".

There's no easy way to enable and disable highlighting just for
specific lines, but individually unsetting the highlight language per
block suppresses the warnings.
This commit is contained in:
Milkey Mouse 2020-03-11 15:33:44 -07:00
parent 425f0919df
commit 1edf587bf3
No known key found for this signature in database
GPG Key ID: C6EF5A02F5647987
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/internals/frontends.rst
View File

@ -1,5 +1,5 @@
.. include:: ../global.rst.inc
.. highlight:: json
.. highlight:: none
.. _json_output:
@ -121,6 +121,7 @@ log_message
See Prompts_ for the types used by prompts.
.. rubric:: Examples (reformatted, each object would be on exactly one line)
.. highlight:: json
:ref:`borg_extract` progress::
@ -171,6 +172,7 @@ environment variable that can be used to override the prompt. It is the same for
messages pertaining to the same prompt.
.. rubric:: Examples (reformatted, each object would be on exactly one line)
.. highlight:: none
Providing an invalid answer::
@ -265,6 +267,7 @@ stats
unique_csize
Compressed and encrypted size of all chunks
.. highlight: json
Example *borg info* output::
{