Commit Graph

671 Commits

Author SHA1 Message Date
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
Victor Zverovich
e0d98923c7 Update version 2020-05-10 18:05:46 -07:00
Lindsay Roberts
d59751f0f0 Update date formatting example to use threadsafe localtime 2020-05-02 09:04:31 -07:00
Victor Zverovich
450e8eed97 Fix markup 2020-04-22 09:30:09 -07:00
Victor Zverovich
b8fbcec1be Clarify formatter reuse 2020-04-22 09:15:52 -07:00
Victor Zverovich
5944fcad37 Remove remaining wchar_t instantiation 2020-04-19 16:48:15 -07:00
Victor Zverovich
27e3c0fe9b Update signature in the docs 2020-04-06 07:17:41 -07:00
Victor Zverovich
9bdd1596ce Update version 2020-04-05 06:46:41 -07:00
Victor Zverovich
d1d653d895 Implement the L specifier 2020-04-02 06:58:38 -07:00
Victor Zverovich
0b2eb6501c Add locale example 2020-01-20 08:42:16 -08:00
Victor Zverovich
a844d7ab81 Add namespaces 2020-01-19 19:20:48 -08:00
Victor Zverovich
47d3968092 Add more examples 2020-01-19 19:15:54 -08:00
Victor Zverovich
7800173eb1 Update fill docs 2020-01-19 18:57:32 -08:00
Victor Zverovich
bd5f903f28 Add a locale example 2020-01-18 07:11:45 -08:00
Victor Zverovich
06e437fd98 Move docs to the proper place 2020-01-18 06:59:21 -08:00
Victor Zverovich
674c326d7c
Update syntax.rst 2019-12-29 07:25:34 -10:00
Victor Zverovich
061a9897fe
Update syntax.rst 2019-12-26 16:49:40 -10:00
Victor Zverovich
162995fedd Add os.h to docs 2019-12-18 14:17:49 -08:00
Victor Zverovich
adbed11ed4 Fix a typo 2019-12-13 15:49:40 -08:00
Victor Zverovich
f94b7364b9 Update version 2019-12-11 06:16:42 -08:00
Victor Zverovich
4f4d876616 Remove '%' from the docs 2019-12-06 07:06:19 -08:00
Victor Zverovich
071794ec65 Update version 2019-12-04 12:21:48 -08:00
Victor Zverovich
4ca6821e8f Update version 2019-12-01 16:58:40 -08:00
Victor Zverovich
0184df7020 Update docs 2019-12-01 14:49:56 -08:00
Victor Zverovich
ef7369ce90 Update docs 2019-11-28 08:09:46 -08:00
Victor Zverovich
34e921f6fe Update docs 2019-11-27 09:26:32 -08:00
Victor Zverovich
57b6f2966d Deprecate the fmt macro 2019-11-19 11:28:17 -08:00
Victor Zverovich
7e1cb3237a Fix indentation 2019-11-17 13:17:43 -08:00
Victor Zverovich
1c6d85f7bb Apply coding conventions to examples 2019-11-17 10:15:16 -08:00
Victor Zverovich
4a1da44f91 Apply coding conventions to examples 2019-11-17 10:14:06 -08:00
Victor Zverovich
080b6899d2 Tweak the docs 2019-11-17 10:10:32 -08:00
Victor Zverovich
c01ec54fde Document and clean basic_format_parse_context 2019-11-17 09:28:26 -08:00
Victor Zverovich
ceff9b0b2e Tweak the docs 2019-11-16 07:14:57 -08:00
Tom de Geus
3dc8639f8a [docs] Added conda 2019-11-16 06:19:33 -08:00
Victor Zverovich
d4ca54253a Update docs 2019-11-06 12:48:21 +00:00
Victor Zverovich
5bb7b28e15 Document members 2019-11-05 10:43:18 +00:00
Victor Zverovich
ffd05e65ed basic_parse_context -> basic_format_parse_context per standard and document 2019-11-05 07:13:58 +00:00
Jeremy Ong
b4f1988c4b Provide overload for fmt::join that handles std::tuples
Address enhancement request #1322.

The overload is provided in `ranges` (original `fmt::join` exists
currently in `format.h` for historical reasons.

Tests for prvalue and lvalue tuple arguments as well as the empty
tuple are provided in `ranges-test.cc`.
2019-09-27 14:05:35 -07:00
Victor Zverovich
19547d5148
Update index.rst 2019-09-06 13:27:28 -07:00
Victor Zverovich
f7a4b4ab91 Make numeric alignment optional 2019-09-06 09:43:53 -07:00
Victor Zverovich
fe642d7648 Clarify use of the core API in header-only mode (#1296) 2019-09-02 17:14:30 -07:00
Victor Zverovich
d1dd9d5327 Document floating-point n specifier (#1291) 2019-08-31 08:16:47 -07:00
Victor Zverovich
3f75e2b69e Make buffer_range public and update custom formatting docs (#1281) 2019-08-28 06:50:20 -07:00
Victor Zverovich
7512a55aa3 Update version 2019-08-26 06:23:37 -07:00
Victor Zverovich
5a4b24613b Update the default floating-point format docs (#1270) 2019-08-22 15:21:14 -07:00
Samuel Debionne
2aae6b120c Fix doc for importing header only target with CMake 2019-08-14 13:59:15 -07:00
Kais Ben Salah
d0f2f3b816 Update usage.rst 2019-07-27 20:25:40 +03:00
Jonathan Wakely
1235f0a24a Fix typo in usage.rst 2019-07-24 15:54:02 +02:00
Victor Zverovich
a3a74672a0 Update signatures 2019-07-09 17:05:34 -07:00
Victor Zverovich
c11e68305f Update signatures 2019-07-09 17:01:13 -07:00
Victor Zverovich
3eff8f94d2 Update docs 2019-06-05 06:24:18 -07:00
Victor Zverovich
4aa0dc578b Fix docs 2019-06-04 18:02:55 -07:00
Victor Zverovich
1530242551 Fix signature in the docs 2019-06-03 17:35:15 -07:00
Victor Zverovich
7e42c65bb6 Document a more useful to_string_view overload 2019-06-03 11:57:33 -07:00
Victor Zverovich
1e6e87cb74 Update docs 2019-06-03 11:35:12 -07:00
Victor Zverovich
0c6a6e0250 Get rid of the FILE* hack and reword apidocs 2019-06-03 10:27:00 -07:00
Victor Zverovich
634f707f2b Simplify char_t and remove msvc2013 from CI 2019-05-31 19:28:37 -07:00
Victor Zverovich
9b3c24b99b One weird trick to simplify docs; doxygen hates it 2019-05-29 21:09:43 -07:00
Victor Zverovich
afc571aedc Document join and relax its compiler requirements 2019-05-29 11:21:05 -07:00
Victor Zverovich
2346779d6b More documentation fixes 2019-05-18 09:30:36 -07:00
Victor Zverovich
afc1a74a6c Minor documentation fixes 2019-05-18 09:10:17 -07:00
Victor Zverovich
ad0eade471 Remove MSVC nonsense 2019-05-18 09:05:19 -07:00
Victor Zverovich
28c187bcd7 Capitalize titles 2019-05-18 08:56:49 -07:00
Victor Zverovich
91bb3aaf06 fmtlib.net -> fmt.dev 2019-05-17 15:42:00 -07:00
Billy Donahue
f569c1ba28 doc fix: time -> chrono
Change refs to fmt/time.h -> fmt/chrono.h
RST label rename time-api -> chrono-api
2019-04-12 14:51:32 -07:00
Victor Zverovich
a4969ebe06 Link to fmt(...) docs from index 2019-04-10 19:22:10 -07:00
Victor Zverovich
918ab77baa Try fixing doc build 2019-04-06 10:04:56 -07:00
Tommy Nguyen
b588d7f35f Fix a couple of deprecated things. 2019-04-04 16:26:22 -07:00
Victor Zverovich
17c6900f83 Update docs 2019-03-17 14:15:48 -07:00
Victor Zverovich
ec645ca262 Update readme and doxygen config 2019-03-16 10:47:50 -07:00
Victor Zverovich
5466a5b41f Document inherited members 2019-03-16 08:22:16 -07:00
Gawain Bolton
2d981bb133 Add documentation for '%' format type. (#1071) 2019-03-06 11:50:32 -10:00
Victor Zverovich
4e5694fd05 Update arg signature 2019-02-21 17:38:30 -10:00
Victor Zverovich
bf6529f2ce Update docs 2019-01-30 06:07:59 -08:00
Victor Zverovich
06c005b7b0 Clarify that compile-time checks don't support named arguments 2019-01-27 10:10:13 -08:00
Victor Zverovich
1b8a216ddf Improve docs 2018-12-28 15:05:42 -08:00
Victor Zverovich
9e554999ce Update version 2018-12-28 12:31:41 -08:00
Victor Zverovich
587a7f6634 Update changelog and docs 2018-12-24 10:56:13 -08:00
Victor Zverovich
130e412b64 Update changelog and docs 2018-12-24 09:37:52 -08:00
HecticSerenity
61ad543c3e Windows .sln filename changed from FORMAT to FMT 2018-12-14 07:50:54 -08:00
Victor Zverovich
37f599b1a1 Fix docs 2018-12-12 17:50:50 -08:00
Victor Zverovich
2b2cfdac19 Update docs 2018-11-28 12:53:09 -08:00
Victor Zverovich
36161284e2 Update docs 2018-10-28 09:28:51 -07:00
Victor Zverovich
38f355d87b Revert "find sphinx-build before calling build.py"
This reverts commit 07200f445a because
the latter doesn't work with virtualenv correctly.
2018-10-28 09:26:21 -07:00
Victor Zverovich
4373153800
Update usage.rst 2018-10-27 12:59:51 -07:00
Kefu Chai
10e03e695b use found python executable for launching sphinx-build
there is chance that the distro install python as python3, in that case
the shebang of
```
```
in build.py won't work.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2018-10-13 09:14:53 -07:00
Kefu Chai
07200f445a find sphinx-build before calling build.py
this allows us to use sphinx-build-3, as user might already in a python3
world, and distros, like fedora 28, tend to add a "-3" suffix to sphinx-build.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2018-10-13 09:14:53 -07:00
Dmitry Petrashko
167f8fe325 Fix a typo in api.rst 2018-10-10 10:51:43 -07:00
Victor Zverovich
7bebb3e128 Clarify overload resolution in docs 2018-10-10 09:41:46 -07:00
Mathew Cucuzella
61f81a0719 minor documentation corrections
In the Format API section, it says fmt:print writes to a file, but it
writes to a stream as referenced from fopen(3), "stream open
functions". Also in the Safety section a typo; tim should be time.
2018-10-08 06:27:25 -07:00
Victor Zverovich
655ce53383 is_format_string -> is_string 2018-10-07 12:45:22 -07:00
Victor Zverovich
041bf83d9b Improve fmt::format readability 2018-10-05 18:42:02 -07:00
Victor Zverovich
2299032392 Document how to write a formatter for a type hierarchy 2018-10-05 13:21:29 -07:00
Victor Zverovich
0f98de3011 Update docs 2018-10-03 12:07:55 -07:00
Victor Zverovich
49b4c1e9db Update docs 2018-10-02 06:21:19 -07:00
Victor Zverovich
3e75ad9822 Update version 2018-09-21 10:18:51 -07:00
Daniel Marshall
894b6fac8e Changed to use scoped enum
Changed "reusing existing formatters example" to use scoped enum instead.
2018-09-16 17:28:40 -07:00
Victor Zverovich
e758bfbae1 Merge branch 'release' of github.com:fmtlib/fmt 2018-09-13 07:38:23 -07:00
Victor Zverovich
295a0d84d9 Update version 2018-09-13 07:28:20 -07:00
Victor Zverovich
1fb1c4c912 Update docs 2018-09-13 07:20:43 -07:00
Victor Zverovich
8671689449 Update docs and formatting 2018-09-08 09:06:54 -07:00
Victor Zverovich
ba95e36a58 Clarify that '\0' cannot be used as fill (#832) 2018-08-19 08:37:40 -07:00
Victor Zverovich
5c0101ab2d Use the correct function signature in the docs 2018-08-12 11:34:48 -07:00
Victor Zverovich
fbe6410e53 Fix docs 2018-08-12 08:52:47 -07:00
Victor Zverovich
35538ca66c Merge more format overloads 2018-07-22 12:24:47 -07:00
Victor Zverovich
48dff9f3c5 Update docs 2018-07-18 06:44:46 -07:00
Victor Zverovich
60c662b3a7 Add an example of reusing formatters 2018-07-08 15:00:44 -07:00
Victor Zverovich
c2ce7e4f07 Update version 2018-07-05 06:22:54 -07:00
Victor Zverovich
e3707ef14b Document that file should be in wide-oriented mode for wide print 2018-06-09 09:12:49 +02:00
Victor Zverovich
94b476283c Fix docs 2018-06-04 19:56:22 +02:00
Victor Zverovich
5386f1df20 Update version 2018-05-21 21:00:04 -07:00
Victor Zverovich
6966db1dab Update docs 2018-05-20 17:10:34 -07:00
Victor Zverovich
728e4f5a8d Fix docs 2018-05-16 08:26:55 -07:00
Victor Zverovich
8c2557710d Update docs and changelog 2018-05-16 07:58:53 -07:00
Victor Zverovich
78677e3fcf Update ChangeLog and docs 2018-05-13 12:42:55 -07:00
Victor Zverovich
ad23270ec7 Document to_wstring 2018-05-13 09:11:29 -07:00
Victor Zverovich
dfb6546932 Fix docs 2018-05-13 08:04:39 -07:00
Victor Zverovich
dece85b31f Fix docs, take 2 2018-05-12 13:57:56 -07:00
Victor Zverovich
6a1df3bd05 Fix docs 2018-05-12 12:57:16 -07:00
Victor Zverovich
f0ae725721 Clarify the use of allocators 2018-05-09 06:43:54 -07:00
Victor Zverovich
bb738c4c26 Remove section on Write API since it's being superceeded by compile-time Format API 2018-04-15 09:13:44 -07:00
Victor Zverovich
52fcef1e57 Update docs 2018-04-08 07:33:07 -07:00
Victor Zverovich
9764f55891 Update docs 2018-04-04 07:53:19 -07:00
Victor Zverovich
4ef97b9bb2 Add a missing comma 2018-04-04 07:43:51 -07:00
Victor Zverovich
c5ebecf7c6 Document format_to_n 2018-03-30 08:31:41 -10:00
Victor Zverovich
e8aa0f3315 Update docs 2018-03-21 06:12:10 -07:00
Victor Zverovich
17258e9c63 Update docs 2018-03-19 19:47:14 -07:00
Victor Zverovich
b58c8ddeb4 Update docs 2018-03-16 16:04:12 -04:00
johnthagen
9c5f54a723 Add format example for padded hex byte
Fixes #2
2018-03-13 23:05:48 -04:00
Victor Zverovich
9facc119a6 Update docs 2018-03-10 09:44:37 -08:00
Victor Zverovich
f867d08239 Update docs 2018-03-04 12:09:34 -08:00
Victor Zverovich
f1ede6380b Make inline_buffer_size public and update docs 2018-03-04 10:33:42 -08:00
Victor Zverovich
995b63adfe Update copyright 2018-03-04 10:11:44 -08:00
Victor Zverovich
4023291759 Update docs 2018-03-04 09:55:17 -08:00
Victor Zverovich
86a9bc8291 Cleanup 2018-03-04 09:16:51 -08:00
Victor Zverovich
b7632e9641 Make format_to return iterator and update docs 2018-03-04 08:13:08 -08:00
Victor Zverovich
5281ea6ad2 do_vformat_to -> vformat_to and update docs 2018-03-04 06:40:43 -08:00
Victor Zverovich
d07ba49821 Fix docs 2018-03-03 22:12:23 -08:00
johnthagen
e92ba1071d Fix Python str.format link to point to Python 3 docs 2018-02-20 17:40:49 +00:00
Victor Zverovich
4ba3f7db82 Update docs 2018-02-15 18:52:44 -08:00
Victor Zverovich
f3f19e762f Update docs 2018-02-11 13:43:16 -08:00
Victor Zverovich
e9fa42acb8 Fix docs and build issues on gcc-4.6 2018-02-11 09:43:54 -08:00
Victor Zverovich
9710c058aa Update documentation building script 2018-02-11 09:23:17 -08:00