Skip to content

Commit df6d691

Browse files
committed
Fixes sphinx 'note' and 'warning' directive formatting.
1 parent 49f6519 commit df6d691

File tree

3 files changed

+24
-18
lines changed

3 files changed

+24
-18
lines changed

libs/network/doc/examples/http/http_client.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,13 @@ You can then run this to get the Boost_ website:
5050
5151
.. _Boost: http://www.boost.org/
5252

53-
.. note:: The instructions for all these examples assume that
54-
:mod:`cpp-netlib` is build outside the source tree,
55-
according to `CMake conventions`_. For the sake of
56-
consistency we assume that this is in the
57-
``~/cpp-netlib-build`` directory.
53+
.. note::
54+
55+
The instructions for all these examples assume that
56+
:mod:`cpp-netlib` is build outside the source tree,
57+
according to `CMake conventions`_. For the sake of
58+
consistency we assume that this is in the
59+
``~/cpp-netlib-build`` directory.
5860

5961
.. _`CMake conventions`: http://www.cmake.org/Wiki/CMake_FAQ#What_is_an_.22out-of-source.22_build.3F
6062

libs/network/doc/getting_started.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,12 @@ additional parameters::
126126
> -DCMAKE_CXX_COMPILER=g++ \
127127
> ../cpp-netlib
128128

129-
.. note:: While it's not compulsory, it's recommended that
130-
:mod:`cpp-netlib` is built outside the source directory.
131-
For the purposes of documentation, we'll assume that all
132-
builds are done in ``~/cpp-netlib-build``.
129+
.. note::
130+
131+
While it's not compulsory, it's recommended that
132+
:mod:`cpp-netlib` is built outside the source directory.
133+
For the purposes of documentation, we'll assume that all
134+
builds are done in ``~/cpp-netlib-build``.
133135

134136
If you intend to use the SSL support when using the HTTP client libraries in
135137
:mod:`cpp-netlib`, you may need to build it with OpenSSL_ installed or at least

libs/network/doc/reference/http_request.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -152,15 +152,17 @@ Directives are meant to be used in the following manner:
152152

153153
request << directive(...);
154154

155-
.. warning:: There are two versions of directives, those that are applicable to
156-
messages that support narrow strings (``std::string``) and those that are
157-
applicable to messages that support wide strings (``std::wstring``). The
158-
:mod:`cpp-netlib` implementation still does not convert wide strings into
159-
UTF-8 encoded narrow strings. This will be implemented in subsequent
160-
library releases.
161-
162-
For now all the implemented directives are listed, even if some of them still
163-
do not implement things correctly.
155+
.. warning::
156+
157+
There are two versions of directives, those that are applicable to
158+
messages that support narrow strings (``std::string``) and those that are
159+
applicable to messages that support wide strings (``std::wstring``). The
160+
:mod:`cpp-netlib` implementation still does not convert wide strings into
161+
UTF-8 encoded narrow strings. This will be implemented in subsequent
162+
library releases.
163+
164+
For now all the implemented directives are listed, even if some of them still
165+
do not implement things correctly.
164166

165167
*unspecified* ``source(std::string const & source_)``
166168
Create a source directive with a ``std::string`` as a parameter, to be set

0 commit comments

Comments
 (0)