From 8cf0afaf1c26d8af736e3086f62c748768e3b91a Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Sun, 8 Nov 2020 06:48:34 -0800 Subject: [PATCH] Improve docs --- doc/api.rst | 13 ++++++------- doc/build.py | 11 +++++++---- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index c3d47dfd..0c506190 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -443,13 +443,12 @@ Format string compilation ========================= ``fmt/compile.h`` provides format string compilation support when using -``FMT_COMPILE``. Format strings are parsed, checked and converted -into efficient formatting code at compile-time. -This supports arguments of built-in and string types as well as user-defined types -with ``constexpr`` ``parse`` functions in their ``formatter`` specializations. -Format string compilation can generate more binary code compared to the default -API and is only recommended in places where formatting is a performance -bottleneck. +``FMT_COMPILE``. Format strings are parsed, checked and converted into efficient +formatting code at compile-time. This supports arguments of built-in and string +types as well as user-defined types with ``constexpr`` ``parse`` functions in +their ``formatter`` specializations. Format string compilation can generate more +binary code compared to the default API and is only recommended in places where +formatting is a performance bottleneck. .. doxygendefine:: FMT_COMPILE diff --git a/doc/build.py b/doc/build.py index dadeb80a..840c3a0c 100755 --- a/doc/build.py +++ b/doc/build.py @@ -89,11 +89,14 @@ def build_docs(version='dev', **kwargs): fmt::basic_format_arg::handle '''.format(include_dir, doxyxml_dir).encode('UTF-8')) noisy_warnings = [ - 'warning: .* fmt::detail::.* is not documented.', - 'warning: Internal inconsistency: member .* does not belong to any ' + - 'container!' + 'warning: Internal inconsistency: .* does not belong to any container!' ] - for w in noisy_warnings: + internal_symbols = [ + 'fmt::detail::.*', + 'basic_data<>', + 'fmt::dynamic_formatter' + ] + for w in noisy_warnings + ['(' + '|'.join(internal_symbols) + ')']: out = re.sub('.*' + w + '\n', '', out) print(out) if p.returncode != 0: