diff --git a/docs/faq.rst b/docs/faq.rst index 5b1e8d64..8e011f4f 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -51,8 +51,8 @@ naming and we came up with ``q_`` prefix which results in a creation of quantity of a provided unit. -Why do we use UDLs reserved for the C++ standard (no `_` prefix)? -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Why do we use UDLs reserved for the C++ standard (no ``_`` prefix)? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This library is meant to become a part of the C++ Standard Library at some point in the future. We decided to work with the target interface to get implementation @@ -63,8 +63,8 @@ with literals already existing in the language in our initial approach This approach has some side effects though. We had to disable some compiler warnings to make it work: -- `/wd4455` on MSVC, -- `-Wno-literal-suffix` on other compilers. +- ``/wd4455`` on MSVC, +- ``-Wno-literal-suffix`` on other compilers. Text formatting diff --git a/docs/usage.rst b/docs/usage.rst index 918a49c7..4184790a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -263,7 +263,7 @@ differences: `the project's README file `_ or on `the project's Bintray `_. -3. Force Conan to check for updated recipes `-u` and to build outdated packages `-b outdated`: +3. Force Conan to check for updated recipes ``-u`` and to build outdated packages ``-b outdated``: .. code-block:: shell @@ -281,7 +281,7 @@ enough to handle simple dependencies and configurations. If your project setup i may prefer to use ``cmake`` generator. In such a case the above procedures should be updated as follows: -1. Specify `cmake` generator in your Conan configuration file: +1. Specify ``cmake`` generator in your Conan configuration file: .. code-block:: ini :caption: conanfile.txt @@ -319,7 +319,7 @@ in **mp-units** repository, you should: 1. Add remotes of additional Conan dependencies. 2. Use the *CMakeLists.txt* from the top-level directory. 3. Obtain Python dependencies. -4. Run Conan with :envvar:`CONAN_RUN_TESTS` = ``True``. +4. Run Conan with `CONAN_RUN_TESTS`_ = ``True``. .. code-block:: shell