From c656c17824ff63c4efbb510b64fc856336b7a613 Mon Sep 17 00:00:00 2001 From: Nejc Bertoncelj Date: Sun, 27 Oct 2024 00:15:34 +0200 Subject: [PATCH 1/2] Avoid nesting links and literal blocks in docs As is it is (currently) unsupported in docutils/Sphinx. --- doc/usage.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/usage.rst b/doc/usage.rst index 9579bba..7f7c299 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -214,8 +214,8 @@ This allows one to easily repeat a test of a card as long as the N.h2w files are still available. As a final remark, if you want to run ``f3write`` and ``f3read`` with a -single command, check out the shell script -```log-f3wr`` `__. +single command, check out the ``log-f3wr`` shell script +`here `__. This script runs ``f3write`` and ``f3read``, and records their output into a log file. Use example: ``log-f3wr log-filename /media/michel/5EBD-5C80/`` @@ -470,8 +470,8 @@ does exactly that: If you want to exchange files with H2testw users often, check out the -shell script -```f3write.h2w`` `__. +``f3write.h2w`` shell script +`here `__. This script calls ``truncate`` after ``f3write`` runs successfully. f3probe - the fastest drive test From c83b706249650a40e0ba8c0c94525b3f41e8b051 Mon Sep 17 00:00:00 2001 From: Nejc Bertoncelj Date: Sun, 27 Oct 2024 00:18:17 +0200 Subject: [PATCH 2/2] Disable syntax highlighting defaulting to Python It sometimes adds unwanted syntax highlighting to literal blocks. --- doc/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index c4f7a27..595af3c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -105,6 +105,9 @@ # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' +# Disable default code block language being set to Python. +highlight_language = 'none' + # A list of ignored prefixes for module index sorting. # modindex_common_prefix = []