aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-07 03:04:52 +0000
committerFuwn <[email protected]>2021-06-07 03:04:52 +0000
commit022cafc057634912f586d45f25b2fa0abf40adad (patch)
tree97cb905a80d8d27d31d2b2284a60182e77fe526b
parentfix(readme): escape asterices (diff)
downloadwhirl-022cafc057634912f586d45f25b2fa0abf40adad.tar.xz
whirl-022cafc057634912f586d45f25b2fa0abf40adad.zip
fix(readme): move code-block to seperate block
-rw-r--r--README.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 8f868eb..e937965 100644
--- a/README.rst
+++ b/README.rst
@@ -63,7 +63,11 @@ Documentation about the entire Whirlsplash ecosystem can be found
If you are looking for explicit documentation of only Whirl's source code, you
must generate them yourself be cloning the repository and running the Cargo
-subcommand: :code:`cargo +nightly doc --open --document-private-items --no-deps`.
+subcommand;
+
+.. code-block:: shell
+
+ $ cargo +nightly doc --open --document-private-items --no-deps
Known Issues
------------
@@ -92,8 +96,8 @@ Optional
- `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_
- `Valgrind <https://www.valgrind.org/>`_
-*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are using the Nix shell
-configuration as provided.*
+*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are
+using the Nix shell configuration as provided.*
Benchmarking
------------