Commit Graph

713 Commits

Author SHA1 Message Date
Victor Zverovich
c48353cb75 Update docs 2022-02-13 07:41:15 -08:00
Victor Zverovich
ecd6022c24 Update docs 2022-02-08 06:28:22 -08:00
Victor Zverovich
a5a7e3a261 Update docs 2022-02-04 15:42:22 -08:00
Victor Zverovich
09fde7f4b8 Add fmt::underlying for enum classes 2022-01-22 08:06:22 -08:00
Victor Zverovich
58fb782396 Improve docs 2022-01-13 14:57:17 -08:00
Pokechu22
c056a009de
Docs: Fix link to "Compile-time Format String Checks" section (#2712) 2022-01-12 16:07:56 -08:00
Barry Revzin
c06bef7273
Adding comments for range formatting. (#2706)
* Adding comments for range formatting.

* Adding missing quotes
2022-01-08 16:37:21 -08:00
Victor Zverovich
b6f4ceaed0 Update version 2022-01-06 14:35:15 -08:00
Victor Zverovich
7081a6aa34 Update version 2022-01-02 09:01:32 -08:00
Victor Zverovich
3014b3d770 Clarify that C strings must be null-terminated 2021-12-26 07:23:43 -08:00
Lounarok
ec3b097cb9
[doc] FMT_STRING supports C++14 and no-op in C++11 (#2620)
* FMT_STRING supports C++14 and no-op in C++11

* Move requirement to the end. Modify description.
2021-11-28 07:02:15 -08:00
Vladislav Shchapov
6eaceb5f73
Fix incompatible between docutils 1.18.0 and sphinx 3.3.0 (#2575) 2021-10-30 09:12:36 -07:00
zhsj
e6d5059cbb
Simplify js tag in basic-bootstrap theme (#2562)
When build the docs for debian package, it uses a sphinx building
helper, which does a sanity check for the output.

The sanity check complains missing data-url_root attribute in the
js tag. So this patch changes the js tag to use the same function like
the origin basic theme, which adds additional information like
data-url_root.

Ref: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=997437
2021-10-24 06:36:10 -07:00
Victor Zverovich
f5371a75f4 locale.h -> format.h 2021-10-14 15:57:10 -07:00
Victor Zverovich
1e865b3539 Fix docs 2021-10-03 07:05:31 -07:00
Victor Zverovich
134aec40f0 Fix search in docs 2021-10-02 07:58:08 -07:00
Victor Zverovich
48a476ae0f Update example (#2522) 2021-10-02 07:33:33 -07:00
Victor Zverovich
5092b198bc Document group_digits 2021-09-18 10:50:30 -07:00
Victor Zverovich
25af02f21a positive -> nonnegative (#2493) 2021-09-10 08:52:54 -07:00
Victor Zverovich
cb0f177c35 Improve docs 2021-08-29 11:30:35 -07:00
Victor Zverovich
71677e5204 Improve docs 2021-08-29 11:21:38 -07:00
Victor Zverovich
dc7f3ef2bb Fix header name 2021-08-28 20:34:45 -07:00
Victor Zverovich
419ba86a91 Improve docs 2021-08-28 16:54:58 -07:00
Victor Zverovich
2599163b8a Document format_string 2021-08-28 15:20:56 -07:00
Victor Zverovich
8ef22f7740 Update docs 2021-08-28 12:05:30 -07:00
Victor Zverovich
c0c4d1adab Update docs 2021-08-28 11:52:13 -07:00
Victor Zverovich
e41ac1f875 Don't use deprecated API in docs 2021-07-10 13:42:51 -07:00
Victor Zverovich
d141cdbeb0 Update version 2021-07-02 16:14:33 -07:00
Victor Zverovich
c6b1f181aa Fix docs 2021-06-27 09:06:21 -07:00
Victor Zverovich
3156fcf5f4 Switch to older breathe version 2021-06-27 08:10:37 -07:00
Victor Zverovich
0bc3d664e3 Fix docs 2021-06-27 06:41:54 -07:00
Victor Zverovich
e5c46e13e8 Fix docs: breathe 18 and earlier corrupts trailing return type 2021-06-26 09:55:27 -07:00
Victor Zverovich
9e8b86fd2d Update version 2021-06-21 05:59:17 -07:00
Victor Zverovich
7a39837d96 Use a working breathe version 2021-06-19 07:35:09 -07:00
Victor Zverovich
55b6e92db5 Fix docs 2021-06-19 06:31:19 -07:00
Victor Zverovich
69dc3a8535 Fix docs 2021-06-18 12:51:48 -07:00
Victor Zverovich
36c2948225 Update docs 2021-06-08 08:25:50 -07:00
Victor Zverovich
ef826b86cb Fix docs 2021-06-04 20:34:58 -07:00
Victor Zverovich
e27b1ce50c Fix docs 2021-06-03 09:32:12 -07:00
Victor Zverovich
9f8b6daca2 Fix wheel installation 2021-06-03 09:10:07 -07:00
Victor Zverovich
1085cc2178 Fix docs 2021-06-03 08:28:02 -07:00
Victor Zverovich
11addaa16e Update docs 2021-06-03 06:24:17 -07:00
Victor Zverovich
760ca5ccc0 Update docs 2021-06-02 19:45:42 -07:00
Victor Zverovich
aa09e0f5dd Update docs 2021-06-02 16:25:21 -07:00
Victor Zverovich
7b9d69b827 Add xchar.h to docs 2021-06-02 08:19:54 -07:00
Victor Zverovich
cbd861f188 Update docs 2021-06-02 08:06:52 -07:00
Victor Zverovich
faf972f039 Update docs 2021-06-02 07:46:26 -07:00
Mark de Wever
1f308a3cea Update integer presentation types documentation.
Documents that the 'c' type is a valid type for integer types. Since
boolean uses the same types as integer its documentation is
automatically updated.
2021-05-24 10:55:08 -07:00
Victor Zverovich
56f518a98f Update signatures 2021-05-19 09:45:33 -07:00
Victor Zverovich
b7f2933744 Update signatures 2021-05-19 09:39:32 -07:00
Victor Zverovich
7483dfc652 Update signatures 2021-05-19 09:36:12 -07:00
Victor Zverovich
8f0fadfaaa Cleanup docs 2021-05-11 20:20:03 -07:00
Victor Zverovich
00f3d16b12 Update docs 2021-04-10 08:07:16 -07:00
Victor Zverovich
d28101878a Document ostream support limitation 2021-03-12 15:49:22 -08:00
Mike Crowe
e6ef927e6b
fmt::ptr: Support function pointers (#2131)
Passing a function pointer to fmt::ptr results in:

 In file included from /home/mac/git/fmt/test/gmock/gmock.h:238,
                  from /home/mac/git/fmt/test/format-test.cc:31:
 .../fmt/test/format-test.cc: In member function ‘virtual void FormatterTest_FormatPointer_Test::TestBody()’:
 .../fmt/test/format-test.cc:1486:56: error: no matching function for call to ‘ptr(void (&)(int, double, std::__cxx11::string))’
              format("{}", fmt::ptr(function_pointer_test)));

with GCC and Clang. Let's add an overload to support that usage.

Unfortunately, MSVC would
consider the overload to be ambiguous for unknown reasons:

 D:\a\fmt\fmt\test\format-test.cc(1485,1): error C2668: 'fmt::v7::ptr': ambiguous call to overloaded function [D:\a\fmt\build\test\format-test.vcxproj]
 D:\a\fmt\fmt\include\fmt/format.h(3742,60): message : could be 'const void *fmt::v7::ptr<void,int,double,std::string>(T (__cdecl *)(int,double,std::string))' [D:\a\fmt\build\test\format-test.vcxproj]
           with
           [
               T=void
           ]
 D:\a\fmt\fmt\include\fmt/format.h(3735,42): message : or       'const void *fmt::v7::ptr<void(int,double,std::string)>(T (__cdecl *))' [D:\a\fmt\build\test\format-test.vcxproj]
           with
           [
               T=void (int,double,std::string)
           ]
 D:\a\fmt\fmt\test\format-test.cc(1486,1): message : while trying to match the argument list '(overloaded-function)' [D:\a\fmt\build\test\format-test.vcxproj]

but luckily this means that the overload is unnecessary in that case
anyway, so we can just make it conditional.
2021-02-09 07:35:16 -08:00
Victor Zverovich
373262f9fb Update docs 2021-01-24 09:11:44 -08:00
Victor Zverovich
b4b8917caf Update docs 2021-01-17 09:36:06 -08:00
Victor Zverovich
061e364b25 Document output_file 2021-01-09 07:18:56 -08:00
AlιAѕѕaѕѕιN
018688da2a
Correct a typo on syntax.rst (documentation) (#2081) 2020-12-31 16:23:42 -08:00
Victor Zverovich
a750bf3ac6
Update api.rst 2020-12-24 07:09:49 -08:00
Walter Gray
4fa4c9248f
Add tests for FMT_ENFORCE_COMPILE_STRING, fix several errors (#2038) 2020-12-24 06:40:46 -08:00
Victor Zverovich
25a41b80fc
Fix a link to Android.mk (#2057) 2020-12-09 08:04:58 -08:00
谭九鼎
a6fafe2f01
docs: use https for some links (#2051) 2020-12-05 06:41:38 -08:00
Victor Zverovich
f43416e1d7 Add a link to contents from index 2020-12-02 06:30:09 -08:00
Victor Zverovich
9ed0a98178 Fix docs build 2020-11-29 09:33:09 -08:00
Victor Zverovich
3f4839ce3d Merge branch 'release' of github.com:fmtlib/fmt 2020-11-25 06:41:05 -08:00
Victor Zverovich
7bdf0628b1 Update version 2020-11-24 17:15:02 -08:00
Victor Zverovich
38c7def47a Update clang version to 3.4 since there are ICEs on earlier ones 2020-11-19 10:37:43 -08:00
Victor Zverovich
4881677268 Update signatures 2020-11-08 12:29:26 -08:00
Victor Zverovich
4c2d637203 Update signatures 2020-11-08 10:10:44 -08:00
Victor Zverovich
beaff39618 Update signatures 2020-11-08 10:00:08 -08:00
Victor Zverovich
ffa0a0834a Use newer versions of Sphinx and Breathe 2020-11-08 09:46:27 -08:00
Victor Zverovich
038057eb3e Document contexts 2020-11-08 08:16:23 -08:00
Victor Zverovich
10ebe6cb48 Document color 2020-11-08 07:18:01 -08:00
Victor Zverovich
1ac50fcb5a Suppress more bogus warnings 2020-11-08 07:04:42 -08:00
Victor Zverovich
e098be8e88 Fix warning filtering 2020-11-08 06:58:41 -08:00
Victor Zverovich
8cf0afaf1c Improve docs 2020-11-08 06:48:34 -08:00
Victor Zverovich
e29f93e8a8 Suppress more bogus warnings 2020-11-08 06:33:42 -08:00
Victor Zverovich
4e8d000f76 Suppress more bogus warnings 2020-11-08 06:29:50 -08:00
Victor Zverovich
7787792e8d Fix re usage 2020-11-08 06:20:53 -08:00
Victor Zverovich
6ee5e507c7 Fix imports 2020-11-08 06:16:49 -08:00
Victor Zverovich
06ee32d1b5 Filter useless doxygen warnings 2020-11-08 06:13:56 -08:00
Victor Zverovich
4f7df299ea Improve docs 2020-11-08 05:40:39 -08:00
Victor Zverovich
8f2131cf2d Document chrono 2020-11-07 10:51:08 -08:00
Victor Zverovich
32c4af8f0d Document chrono 2020-11-07 10:38:51 -08:00
Victor Zverovich
295a60ec8d Document chrono 2020-11-07 10:30:23 -08:00
Victor Zverovich
a4fae96c96 Document chrono 2020-11-07 10:24:27 -08:00
Victor Zverovich
263bb0e68d Document chrono 2020-11-07 10:19:40 -08:00
Victor Zverovich
0506b328b5 Document chrono 2020-11-07 09:59:57 -08:00
Victor Zverovich
4e426c19d0 Document chrono 2020-11-07 09:47:56 -08:00
Victor Zverovich
9795d87348 Update docs 2020-11-07 09:27:06 -08:00
Victor Zverovich
2eb0be0b73 Remove debug code and fix bot contact 2020-11-07 09:16:55 -08:00
Victor Zverovich
98639d0f6f Debug doc build 2020-11-07 09:04:07 -08:00
Victor Zverovich
ab5e0632fe Debug doc build 2020-11-07 08:54:58 -08:00
Victor Zverovich
81d2b986af Print less command 2020-11-07 08:24:58 -08:00
Victor Zverovich
75b07598fe Chrono docs 2020-11-07 07:56:53 -08:00
Victor Zverovich
cc09f1a679 Update version 2020-11-04 06:50:09 -08:00
Victor Zverovich
5f7f7b954d Update version 2020-11-01 06:30:39 -08:00
Victor Zverovich
4fe0b11195 Update version 2020-10-25 10:44:22 -07:00
Victor Zverovich
764fb35e1f Always install the required version of breathe 2020-10-25 10:34:47 -07:00
Victor Zverovich
e1bdc0ecaf Use the correct version of sphinx 2020-10-25 09:52:21 -07:00
Adnan
17fba753c4
added position independent documentation (#1939)
* added position independent documentation

* suggested fixes to usage

* linebreaks

Co-authored-by: Adnan Yunus <adnan@opus.ai>
2020-10-19 14:20:54 -07:00
Victor Zverovich
7b50dc0b24 Don't exclude all detail symbols from docs 2020-10-07 09:07:39 -07:00
Victor Zverovich
2805243103 Fix the doc config 2020-10-07 08:11:59 -07:00
francesco-st
7277035736 Fix long lines in usage.md 2020-10-06 06:26:11 -07:00
francesco-st
7612c1ea87 Add reference to lhelper package manager in usage 2020-10-06 06:26:11 -07:00
Victor Zverovich
05a28312cf Update docs 2020-09-30 17:38:28 -07:00
Victor Zverovich
4d0aa4d8fe Update link 2020-09-30 17:21:07 -07:00
Joël Lamotte
e66ba16923
Added build2 usage instructions. (#1838)
The `fmt` package have been available for `build2` users for several version, see: https://cppget.org/fmt

This simply add the minimum instructions for making a `build2` project depend on it.

There are other ways to do it, but they need more understanding of `build2`.
2020-08-28 15:15:15 -07:00
Victor Zverovich
d16d585e64 Update signatures 2020-08-26 09:35:19 -07:00
Victor Zverovich
a0dcfbc57b Add ptr to docs 2020-08-21 06:54:05 -07:00
Victor Zverovich
c13f79e09e Merge release branch 2020-08-07 07:01:21 -07:00
Victor Zverovich
cd4af11efc Update version 2020-08-06 08:51:01 -07:00
Victor Zverovich
633213d96f Merge release branch 2020-07-29 08:52:53 -07:00
Victor Zverovich
b9d749095e Update version 2020-07-29 07:30:55 -07:00
Victor Zverovich
9c2edfd1aa Partially revert 638db5 because it breaks the doc build 2020-07-26 09:44:37 -07:00
Victor Zverovich
810357c014 Document color 2020-07-26 08:22:56 -07:00
Victor Zverovich
95d3abf95c Make format_to_n part of the core API 2020-07-24 09:25:26 -07:00
Malcolm Parsons
98626093d2
Correct the locale format specifier in api.rst (#1792) 2020-07-23 21:01:54 -07:00
Victor Zverovich
47f8d7a345 Make formatted_size part of the core API 2020-07-23 08:51:38 -07:00
Victor Zverovich
46a63b7087 Update docs 2020-07-23 07:12:19 -07:00
Victor Zverovich
ce73ea37fb Reorder functions 2020-07-20 09:42:14 -07:00
Victor Zverovich
c228bfe882 Improve docs 2020-07-20 07:56:20 -07:00
Victor Zverovich
c08518a25b Move make_args_checked to the public API 2020-07-19 10:23:46 -07:00
Victor Zverovich
e2837084ee Add a color section 2020-07-19 09:51:52 -07:00
Léonard Gérard
f5d4215b7c
Trying to clear ambiguous compile time claims (#1775)
* Trying to clear ambiguous compile time claims

Documentation was a bit misleading.
Many people assume that fmt does compile time checks by default, while it requires the use of `FMT_STRING`.
It was also unclear that FMT_COMPILE does the same checks.

https://github.com/fmtlib/fmt/issues/1772

* Update api.rst
2020-07-16 06:19:49 -07:00
Victor Zverovich
f4b11ef6e2 Add a short anchor 2020-07-14 09:39:22 -07:00
Victor Zverovich
bd903f96ac Clarify precedence 2020-07-12 09:02:31 -07:00
Vitaly Zaitsev
638db5ca5e Use Cmake to find Python and Sphinx-doc.
Signed-off-by: Vitaly Zaitsev <vitaly@easycoding.org>
2020-07-08 08:06:57 -07:00
Victor Zverovich
f19b1a521e Update version 2020-07-07 07:47:44 -07:00
Victor Zverovich
04c9b62fb4 Merge release branch 2020-07-07 06:34:39 -07:00
Victor Zverovich
86b2f99f8c Fix the docs 2020-07-06 07:53:07 -07:00
Victor Zverovich
c472ff12d8 Update version 2020-07-06 06:45:20 -07:00
Victor Zverovich
5173a76ba4 Update version 2020-07-05 08:43:47 -07:00
Victor Zverovich
4e7e3c65a3 Update docs 2020-07-05 07:32:43 -07:00
Victor Zverovich
0f7a6bfa12 Add a section on std::format compatibility 2020-07-05 07:07:29 -07:00
Victor Zverovich
01309a34ab Deprecate arg_formatter 2020-07-04 07:29:11 -07:00
Victor Zverovich
1f3f84631c Fix a typo 2020-07-02 07:29:38 -07:00
Victor Zverovich
8630a8f5ff Tweak the docs 2020-06-25 11:29:49 -07:00
Victor Zverovich
cc3a88e6b3 Extract docs from compile.h 2020-06-25 08:36:07 -07:00
Victor Zverovich
d130ee070f Document format string compilation 2020-06-25 08:12:10 -07:00
Victor Zverovich
d259fcfb05 Tweak comments 2020-06-12 06:22:05 -07:00
文佳鹏
f904e8a1b4
c++11 use formatting user-defined types (#1721) 2020-06-11 10:10:39 -07:00
Jelle van der Waa
8f2b5fe74d Don't install sphinx cache files
When building documentation sphinx creates cached files in the .doctrees
directory and aren't required for viewing documentation only for
building. As added benefit this makes fmt reprodcubile as the cached
files are different when the build environment is varied.
2020-05-30 06:14:02 -07:00
Victor Zverovich
297c3b2ed5 Fix an example (thanks Alexey Kuzmenko) 2020-05-20 15:52:19 -07:00
Victor Zverovich
7aafa6bc64 Update analytics 2020-05-18 10:26:22 -07:00
Victor Zverovich
eee2023c2a Update signatures 2020-05-15 15:25:02 -07:00
Victor Zverovich
c5ed73aab2 Add fmt::detail::buffer to the docs (#704) 2020-05-15 14:35:55 -07:00
Victor Zverovich
d18c6723a2 Update docs 2020-05-15 09:43:35 -07:00
Kevin Puetz
981b517ccf
nested replacement fields may omit arg_id (#1681)
syntax.html already has examples like `fmt::format("{:.{}f}", 3.14, 1)` using this, 
and https://en.cppreference.com/w/cpp/utility/format/formatter#width_and_precision shows that this is the case for the C++20 std::format

The Format Specification Mini-Language grammar seems to be the only one not showing this; update it to match.
2020-05-13 17:20:05 -07:00