Skip to content

Commit

Permalink
Merge pull request #230 from bertronika/docs-fixes
Browse files Browse the repository at this point in the history
Improve rendering of documentation
  • Loading branch information
AltraMayor authored Oct 30, 2024
2 parents d9b0a6c + c83b706 commit 90b298c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
3 changes: 3 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = []

Expand Down
8 changes: 4 additions & 4 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`` <https://github.com/AltraMayor/f3/blob/master/log-f3wr>`__.
single command, check out the ``log-f3wr`` shell script
`here <https://github.com/AltraMayor/f3/blob/master/log-f3wr>`__.
This script runs ``f3write`` and ``f3read``, and records their output
into a log file. Use example:
``log-f3wr log-filename /media/michel/5EBD-5C80/``
Expand Down Expand Up @@ -470,8 +470,8 @@ does exactly that:


If you want to exchange files with H2testw users often, check out the
shell script
```f3write.h2w`` <https://github.com/AltraMayor/f3/blob/master/f3write.h2w>`__.
``f3write.h2w`` shell script
`here <https://github.com/AltraMayor/f3/blob/master/f3write.h2w>`__.
This script calls ``truncate`` after ``f3write`` runs successfully.

f3probe - the fastest drive test
Expand Down

0 comments on commit 90b298c

Please sign in to comment.