Commit 8cab5909 authored by Victor Zverovich's avatar Victor Zverovich

Improve PDF output

parent 80f5cbb9
...@@ -202,7 +202,7 @@ latex_elements = { ...@@ -202,7 +202,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'format.tex', u'format Documentation', ('index', 'format.tex', u'C++ Format Documentation',
u'Victor Zverovich', 'manual'), u'Victor Zverovich', 'manual'),
] ]
......
.. highlight:: c++ .. highlight:: c++
.. _string-formatting-api:
Usage Usage
----- =====
To use the C++ Format library, add ``format.h`` and ``format.cc`` from To use the C++ Format library, add ``format.h`` and ``format.cc`` from
a `release archive <https://github.com/cppformat/cppformat/releases/latest>`_ a `release archive <https://github.com/cppformat/cppformat/releases/latest>`_
...@@ -18,15 +16,17 @@ the line ...@@ -18,15 +16,17 @@ the line
before other includes in ``format.cc``. before other includes in ``format.cc``.
.. _string-formatting-api:
C++ Format Library API C++ Format Library API
---------------------- ======================
All functions and classes provided by the C++ Format library reside All functions and classes provided by the C++ Format library reside
in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the
namespace is usually omitted in examples. namespace is usually omitted in examples.
Formatting functions Formatting functions
^^^^^^^^^^^^^^^^^^^^ --------------------
The following functions use `format string syntax`_ similar to the one The following functions use `format string syntax`_ similar to the one
used by Python's `str.format used by Python's `str.format
...@@ -52,7 +52,7 @@ arguments in the resulting string. ...@@ -52,7 +52,7 @@ arguments in the resulting string.
.. doxygenfunction:: fmt::print(std::ostream &, StringRef, ArgList) .. doxygenfunction:: fmt::print(std::ostream &, StringRef, ArgList)
Printf formatting functions Printf formatting functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ---------------------------
The following functions use `printf format string syntax The following functions use `printf format string syntax
<http://pubs.opengroup.org/onlinepubs/009695399/functions/fprintf.html>`_ with <http://pubs.opengroup.org/onlinepubs/009695399/functions/fprintf.html>`_ with
...@@ -128,7 +128,7 @@ allocator:: ...@@ -128,7 +128,7 @@ allocator::
FMT_VARIADIC(CustomString, format, CustomAllocator, fmt::StringRef) FMT_VARIADIC(CustomString, format, CustomAllocator, fmt::StringRef)
Format String Syntax Format String Syntax
-------------------- ====================
Formatting functions such as :ref:`fmt::format() <format>` and :ref:`fmt::print() <print>` Formatting functions such as :ref:`fmt::format() <format>` and :ref:`fmt::print() <print>`
use the same format string syntax described in this section. use the same format string syntax described in this section.
...@@ -183,7 +183,7 @@ See the :ref:`formatexamples` section for some examples. ...@@ -183,7 +183,7 @@ See the :ref:`formatexamples` section for some examples.
.. _formatspec: .. _formatspec:
Format Specification Mini-Language Format Specification Mini-Language
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ----------------------------------
"Format specifications" are used within replacement fields contained within a "Format specifications" are used within replacement fields contained within a
format string to define how individual values are presented (see format string to define how individual values are presented (see
...@@ -416,7 +416,7 @@ The available presentation types for pointers are: ...@@ -416,7 +416,7 @@ The available presentation types for pointers are:
.. _formatexamples: .. _formatexamples:
Format examples Format examples
^^^^^^^^^^^^^^^ ---------------
This section contains examples of the format syntax and comparison with This section contains examples of the format syntax and comparison with
the printf formatting. the printf formatting.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment