Commit Graph

534 Commits

Author SHA1 Message Date
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
Victor Zverovich
b00053247c Merge the std branch 2018-02-10 07:38:27 -08:00
Victor Zverovich
5b3f9eab94 Update syntax.rst 2018-02-10 07:03:44 -08:00
Victor Zverovich
e802cf14e3 Add note about errno to the documentation 2018-02-10 07:01:59 -08:00
Victor Zverovich
dbd84697ff Update usage.rst 2018-02-10 06:54:26 -08:00
Victor Zverovich
66b25ef0d0 Add examples 2018-02-10 06:33:03 -08:00
Victor Zverovich
8921f613de Update build script 2018-02-02 18:46:39 -08:00
Victor Zverovich
3dae25828f Describe cmake use of header-only target 2018-02-01 16:42:53 -08:00
Victor Zverovich
a5185ec8d4 add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5 2018-01-28 20:20:39 -08:00
Victor Zverovich
19f990a9c0 Use https to fetch dependencies from github 2018-01-27 09:15:28 -08:00
Victor Zverovich
e95e4659d9 Add syntax.rst to build 2018-01-20 17:55:43 -08:00
Victor Zverovich
e51119508c argument index -> argument id 2018-01-20 17:55:28 -08:00
Victor Zverovich
9649919d01 Document use of format_arg for user-defined type #393 2018-01-20 10:07:29 -08:00
Victor Zverovich
c8efe145b4 Add api.rst to build 2018-01-20 09:52:29 -08:00
Victor Zverovich
319346025d Update version 2017-12-20 08:38:07 -08:00
Victor Zverovich
cabce31f45
Update syntax.rst 2017-12-16 08:58:54 -08:00
Mihai Todor
f9c97de46b Add note about errno to the documentation 2017-11-28 07:33:51 -08:00
Victor Zverovich
e805543341 Remove FMT_USE_VARIADIC_TEMPLATES 2017-11-11 07:02:58 -08:00
Victor Zverovich
11415bce3c
Update usage.rst 2017-11-08 18:27:10 -08:00
Victor Zverovich
ca96acbe4f Add examples 2017-10-15 07:38:03 -07:00
Alex Alabuzhev
89654cd127 to_wstring added 2017-08-27 18:52:57 +02:00
Bjorn Fahller
9c56a8ce5c Make format_arg() accept class hierarchies
If a base class can be formatted, it is assumed
that the hierarchy can be formatted from the base
class. The idiom is not uncommon with ostreams.
2017-07-18 06:16:46 -07:00
Victor Zverovich
16bdd8424f Update scripts 2017-07-01 07:30:51 -07:00
Ian Bell
dc8c943372 Describe cmake use of header-only target 2017-05-29 16:31:52 -07:00
Graham Inggs
7a4ac9ec9c add SOURCELINK_SUFFIX for compatibility with Sphinx 1.5
With Sphinx 1.5, this is needed by searchtools.js to display the source
snippets (see sphinx-doc/sphinx#2454).

With earlier Sphinx versions, this is a no-op because the undefined variable
will evaluate to an empty string.
2017-04-15 08:42:05 -07:00
Victor Zverovich
e208fbff52 Document which header defines formatting functions 2017-02-24 07:06:05 -08:00
Victor Zverovich
572491ad1f Document which header defines formatting functions 2017-02-24 07:04:44 -08:00
Jean-Charles Lefebvre
e0251fdcef BasicContainerWriter utility added 2017-01-05 20:44:35 -08:00
Jean-Charles Lefebvre
e1689cb985 Custom FormatSpec (#439) (#444)
* A custom FormatSpec type can be passed as a template argument to the ArgFormatter chain (#439)

* Corrected nested-name-specifier error

* Spec template argument defaulted to FormatSpec

* Forward declaration of FormatSpec

* Style

* Style (part 2)

* Style (part 3)
2016-12-30 11:29:40 -08:00
Victor Zverovich
02553d13a0 Use https to fetch dependencies from github 2016-12-29 10:44:02 -08:00
Victor Zverovich
7ce7def515 argument index -> argument id 2016-11-01 17:00:59 -07:00
Victor Zverovich
f287994084 Fix formatting 2016-10-07 03:22:14 -07:00
Victor Zverovich
4809e2956a Minor documentation changes 2016-10-06 07:38:19 -07:00
Philip Miller
88c4bc33d2 Document use of format_arg for user-defined type 2016-10-05 15:04:08 -04:00
Victor Zverovich
0d25f6fcbb Move the paper to the docs repo 2016-08-27 08:26:47 -07:00
Victor Zverovich
2ae6bca488 Complete syntax section 2016-08-25 07:23:04 -07:00
Victor Zverovich
04335aeadb Correct syntax 2016-08-25 07:08:36 -07:00
Victor Zverovich
3d5125cd87 Update paper 2016-08-25 06:50:09 -07:00
Victor Zverovich
d775a20fff Update paper 2016-08-24 07:41:07 -07:00
Victor Zverovich
4dc9fd995f Update paper 2016-08-24 06:55:18 -07:00
Victor Zverovich
195d6a5663 Update paper 2016-08-23 08:10:35 -07:00
Victor Zverovich
93975c70bb Update paper 2016-08-21 07:50:31 -07:00
Victor Zverovich
53f9e7f65c Add 'a' and 'A' format specifiers 2016-08-20 09:55:07 -07:00
Victor Zverovich
768739c310 Update paper 2016-08-20 07:39:10 -07:00
Victor Zverovich
94d387cd45 Update paper 2016-08-19 21:41:19 -07:00
Victor Zverovich
721c9100f2 Update paper 2016-08-19 16:43:10 -07:00
Victor Zverovich
108498bdd0 Add initial draft of the paper 2016-08-19 09:33:59 -07:00
Victor Zverovich
9dbb60c4c8 Move fmt::fprintf to printf.h 2016-08-03 08:52:05 -07:00
Victor Zverovich
ed30108918 Add "n" to integer formatting types 2016-07-26 07:36:35 -07:00
Victor Zverovich
d5893c9a13 Update homepage and break long lines 2016-07-21 09:00:23 -07:00
Victor Zverovich
6ee9f2ed09 Make printf argument formatters public (#335, #360) 2016-07-21 06:59:28 -07:00
Victor Zverovich
9823675832 Break long lines 2016-07-20 08:17:33 -07:00
Victor Zverovich
d4ddaaf2b1 Make PrintfFormatter public (#335, #360) 2016-07-20 08:09:14 -07:00
Taro Matsuzawa aka. btm
1dbc6bd1fc Update usage.rst: change Homebrew package name 2016-07-20 07:34:21 +09:00
Victor Zverovich
d4885cea62 Document BasicStringWriter 2016-07-16 08:00:53 -07:00
Victor Zverovich
a81bff9349 Update documentation build instructions 2016-06-22 07:18:37 -07:00
Victor Zverovich
2e69e454d0 Fix a link (#347) 2016-06-16 11:18:40 -07:00
Victor Zverovich
c7d0241abb Fix docs 2016-06-15 07:16:04 -07:00
Victor Zverovich
a82026746d Fix download link 2016-06-03 08:19:24 -07:00
Victor Zverovich
81e2dac955 Improve documentation build 2016-06-03 07:19:05 -07:00
Victor Zverovich
5940431e2d Don't exclude the current version from dropdown menu 2016-06-03 06:23:49 -07:00
Victor Zverovich
06045cb4a5 Minor fixes to documentation build scripts 2016-06-02 06:52:07 -07:00
Victor Zverovich
9492b9ff03 Pass versions from CMake to Sphinx 2016-06-02 06:41:25 -07:00
Victor Zverovich
5e70843a73 Don't fail if a package was not found 2016-05-31 08:49:34 -07:00
Victor Zverovich
d25e07660e Specify minimum required Breathe version 2016-05-31 08:46:28 -07:00
Victor Zverovich
579736f210 Don't install Sphinx if it the minimum version is satisfied 2016-05-31 08:40:29 -07:00
Victor Zverovich
8650c57ccd Reuse virtualenv to speed up builds 2016-05-26 08:00:41 -07:00
Victor Zverovich
9071daebe9 Make work dir configurable 2016-05-26 07:35:10 -07:00
Victor Zverovich
fcaf8a0cdc Make virtualenv dir configurable and break long lines 2016-05-26 06:52:51 -07:00
Victor Zverovich
e68836c123 Don't use --upgrade because it causes pip install older version of sphinx 2016-05-25 07:46:47 -07:00
Victor Zverovich
dc1e36fa0e Make documentation installation optional (#333) 2016-05-24 07:03:08 -07:00
Victor Zverovich
7bb1b50835 Update sphinx 2016-05-24 06:55:57 -07:00
Victor Zverovich
b18f783fed Add string.h to the docs 2016-05-18 21:04:34 -07:00
Victor Zverovich
b6c0cf9683 Add fmt::to_string (#326) 2016-05-18 19:54:52 -07:00
Victor Zverovich
cc9b051d12 Move format_system_error to the public API (#323) 2016-05-13 07:19:39 -06:00
Victor Zverovich
d67eb8af2f Correct docs 2016-05-10 11:07:53 -07:00
Victor Zverovich
f76583276a Clarify performance tradeoffs (#320) 2016-05-10 07:29:31 -07:00
Victor Zverovich
31a4f0ab05 Implement website update script 2016-05-09 08:36:16 -07:00
Victor Zverovich
140f11190b Add a website update script 2016-05-08 08:03:01 -07:00
Victor Zverovich
add6bcca3e Document ostream support 2016-05-07 09:09:33 -07:00
Jakub Wilk
e0ac51cbd9 Fix typos 2016-05-01 12:29:21 +02:00
Victor Zverovich
4e279e2a70 Correct formatting 2016-04-29 07:02:37 -07:00
Victor Zverovich
a3929b719a Document date/time formatting and move example to the docs 2016-04-29 06:40:31 -07:00
Victor Zverovich
63be22d5dc Update template 2016-04-28 07:09:05 -07:00
Victor Zverovich
f171d1f3d6 Update a link 2016-04-28 07:05:28 -07:00
Victor Zverovich
c33f3e281b cppformat -> fmt 2016-04-28 07:00:22 -07:00
Victor Zverovich
59d0efd6d6 Update links 2016-04-28 06:54:37 -07:00
Victor Zverovich
c916ab3319 Update docs 2016-04-27 08:35:59 -07:00
Victor Zverovich
7f0d8184c9 cppformat -> fmt 2016-04-24 10:39:33 -07:00
Victor Zverovich
5e1576f79f cppformat -> fmt 2016-04-24 08:17:47 -07:00
Victor Zverovich
848ab63a2a CPPFORMAT_VERSION -> FMT_VERSION 2016-04-24 07:16:33 -07:00
vitaut
bfdca8b576 Make ArgVisitor public and document it
Also remove unnecessary namespace qualification.
2016-04-20 09:11:33 -07:00
vitaut
fb5350543c Correct case 2016-04-20 07:44:37 -07:00
vitaut
ccbc891992 Document argument formatters 2016-04-20 07:16:52 -07:00
vitaut
4d8cee2d48 Document the n format specifier 2016-04-17 20:46:08 -07:00
vitaut
e4f7d0d311 Resolve overloads 2016-04-11 09:32:24 -04:00
vitaut
c0ad9a888b Update the source location in the documentation build script 2016-02-03 09:28:44 -08:00
vitaut
4952e79e45 Document that floating-point formatting is locale-dependent. 2016-01-30 09:20:43 -08:00
vitaut
804ad8f4df Document std::ostream overload of fprintf 2015-12-24 07:00:22 -08:00
vitaut
77d3761b50 Enable macro expansion in Doxygen (fixes #248) 2015-12-24 06:54:37 -08:00
vitaut
811964502d Add BasicFormatter's members to the docs 2015-12-18 07:24:25 -08:00
vitaut
016714c57b Add BasicFormatter to the docs 2015-12-18 07:16:40 -08:00
vitaut
c679352517 Define FMT_API to nothing for Doxygen 2015-12-18 07:13:43 -08:00
vitaut
d998b5d038 Add version 2.0.0 to the dropdown menu 2015-12-18 06:47:37 -08:00
vitaut
bf6651d1ca Add github-btn style 2015-12-17 07:59:09 -08:00
vitaut
5837851cb2 Update docs 2015-12-01 07:31:15 -08:00
vitaut
4118b89139 Get rid of the html directory when installing docs 2015-11-23 08:22:21 -08:00
vitaut
b83fd00183 Pass version from CMake to Sphinx 2015-11-23 08:10:02 -08:00
vitaut
e61c8d4cba Update documentation config 2015-11-11 07:35:31 -08:00
vitaut
7638a3be1e Fixed virtualenv activation on Windows
Thanks to @mapgccv.
2015-10-28 12:21:57 -07:00
vitaut
869ed1ec19 Update breathe 2015-10-21 16:08:50 -07:00
vitaut
cb5a1698c9 Update breathe to fix overload issue 2015-10-20 08:39:34 -07:00
vitaut
caa8f76a88 Make content wider on medium-size devices (#210) 2015-10-17 17:35:51 -07:00
vitaut
044ef900bc Grammar 2015-10-17 08:34:58 -07:00
vitaut
6d9712c7fd Fix links 2015-10-17 08:21:23 -07:00
vitaut
826edabae1 Add building the documentation section 2015-10-17 08:17:32 -07:00
vitaut
5898720c28 Make documentation build script compatible with Python 3 2015-10-17 08:05:58 -07:00
vitaut
a596b8724b Improve error message when less is not installed 2015-10-16 08:28:58 -07:00
vitaut
79d7aacff3 Remove diagnostics 2015-10-16 08:13:54 -07:00
vitaut
aaa8b1e0aa Upgrade distribute if it is 0.6.24 or lower
because installation of sphinx with distribute 0.6.24 available on Travis
is broken.
2015-10-16 08:07:44 -07:00
vitaut
2d921c96e0 Update sphinx 2015-10-16 07:34:38 -07:00
vitaut
ee1fdc575b Print alabaster version 2015-10-16 07:18:04 -07:00
vitaut
418cd1c82a Pip show no more 2015-10-16 07:03:45 -07:00
vitaut
884c55741f Install a version of sphinx without sphinx-rtd-theme
because the latter breaks the sphinx-build
2015-10-16 07:00:19 -07:00
vitaut
221eeda912 Remove diagnostics which is not working 2015-10-15 08:30:16 -07:00
vitaut
d57c6204cd Try installing the stupid sphinx-rtd-theme explicitly 2015-10-15 08:26:44 -07:00
vitaut
694bfb5309 sphinx-rtd-theme -> sphinx_rtd_theme 2015-10-15 08:19:33 -07:00
vitaut
9daa774b5b Import pkg_resources after activating virtualenv 2015-10-15 08:13:32 -07:00
vitaut
1554c9c6e5 Diagnose sphinx-build failure on Travis 2015-10-15 08:09:19 -07:00
vitaut
2a4f98f474 Diagnose sphinx-build failure on Travis 2015-10-15 07:54:41 -07:00
vitaut
39265a4288 Try the latest version of pip 2015-10-15 07:40:34 -07:00
vitaut
a257d811d8 Check if pip has __version__ 2015-10-15 07:20:52 -07:00
vitaut
238d6dc506 Try importing pip after activating virtualenv 2015-10-15 07:14:57 -07:00
vitaut
a5b296a484 More diagnostics 2015-10-15 07:08:26 -07:00
vitaut
e854c7d47e Check if pip is updated 2015-10-15 06:41:16 -07:00
vitaut
e61f4d2bf6 Upgrade to pip 1.5.4 2015-10-14 08:36:58 -07:00
vitaut
ee6f4e7aec Check pip version once and skip pip show for now 2015-10-14 08:31:54 -07:00
vitaut
13c633223e Upgrade pip on Travis 2015-10-14 08:17:39 -07:00