diff options
| author | Jack Lloyd <[email protected]> | 2016-10-22 08:45:50 -0400 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2016-10-22 10:37:26 -0400 |
| commit | 4cc164ccf9035de64c1d783c2cb57032e2f6c6b0 (patch) | |
| tree | 9e7a3e838c011b0d255ef842218ca80bdcb1077c /doc | |
| parent | 6aa855bba613c7b6fedfbe71d15930964acb1633 (diff) | |
Build the docs during CI
Fix various doc building problems/warnings.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/building.rst | 2 | ||||
| -rw-r--r-- | doc/manual/tls.rst | 6 |
2 files changed, 5 insertions, 3 deletions
diff --git a/doc/manual/building.rst b/doc/manual/building.rst index 3ccc1ab8f..f2a545e63 100644 --- a/doc/manual/building.rst +++ b/doc/manual/building.rst @@ -12,6 +12,8 @@ maintainer if you would like to build Botan on such a system. Botan's build is controlled by configure.py, which is a `Python <http://www.python.org>`_ script. Python 2.6 or later is required. +.. highlight:: none + For the impatient, this works for most systems:: $ ./configure.py [--prefix=/some/directory] diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index d0e63b9f8..7ef61e63d 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -103,7 +103,7 @@ information about the connection. This callback is for exerimental purposes and currently unused. It may be removed or modified in a future release. -Versions from 1.11.0 to 1.11.30 did not have ``TLS::Callbacks` and instead +Versions from 1.11.0 to 1.11.30 did not have ``TLS::Callbacks`` and instead used independent std::functions to pass the various callback functions. This interface is currently still included but is deprecated and will be removed in a future release. For the documentation for this interface, please check @@ -223,7 +223,7 @@ TLS Clients .. cpp:class:: TLS::Client .. cpp:function:: Client( \ - Callbacks& callbacks, + Callbacks& callbacks, \ Session_Manager& session_manager, \ Credentials_Manager& creds, \ const Policy& policy, \ @@ -290,7 +290,7 @@ TLS Servers .. cpp:class:: TLS::Server .. cpp:function:: Server( \ - Callbacks& callbacks, + Callbacks& callbacks, \ Session_Manager& session_manager, \ Credentials_Manager& creds, \ const Policy& policy, \ |