From f5fabde23e6ec34c2f722c1ac487cc2d50332e65 Mon Sep 17 00:00:00 2001 From: jensvog <62656589+jensvog@users.noreply.github.com> Date: Mon, 28 Dec 2020 17:03:24 +0100 Subject: [PATCH] Docs: Code prefixes for better formatting Readme file contained several inline code sequences. They were marked with ``. They have no text role, so they are not formatted as code on GitHub. Text role :code: is now used to format the inline code. It better highlights the code sections. --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 18168d4fe..44bf0a320 100644 --- a/README.rst +++ b/README.rst @@ -28,8 +28,8 @@ From PyPI From Source - Git clone repository -- Use `pip install -r requirements.txt` to install the required packages -- or `pipenv install && pipenv install --dev` +- Use :code:`pip install -r requirements.txt` to install the required packages +- or :code:`pipenv install && pipenv install --dev` How to contribute? __________________ @@ -38,7 +38,7 @@ Please, click here `Contribution Guidelines for this project`_ Examples ________ -More **examples** in **``examples/``** directory. +More **examples** in :code:`examples/` directory. Here's a short example of how to create a Confluence page: