Commit Graph

420 Commits

Author SHA1 Message Date
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
vitaut
a08bc864fb Add more diagnostics 2015-10-14 07:13:23 -07:00
vitaut
95fa85cf04 Try uninstalling older version of sphinx 2015-10-14 07:06:13 -07:00
vitaut
f4d38ce3ea Add more diagnostics 2015-10-14 06:52:07 -07:00
vitaut
d6ecf3ae61 Add more diagnostics 2015-10-14 06:43:30 -07:00
vitaut
6dae7f3ba6 Add more diagnostics 2015-10-14 06:39:07 -07:00
vitaut
08bcf61fb2 Add --upgrade option to pip 2015-10-14 06:27:41 -07:00
vitaut
bdbac0b78f More diagnostics 2015-10-13 08:55:05 -07:00
vitaut
5bc908623c Add diagnostics to the documentation build script 2015-10-13 08:45:49 -07:00
vitaut
7732688b80 If Sphinx is already installed but version doesn't match, reinstall it 2015-10-13 08:24:16 -07:00
Dean Moldovan
358ae822bb Update Sphinx with C++11 literals fix and add fmt::literals API docs 2015-10-13 00:35:22 +02:00
Dean Moldovan
47e26cdc37 Document user-defined literals 2015-10-11 02:34:20 +02:00
vitaut
d48047e4c0 Break long line 2015-08-31 08:22:25 -07:00
vitaut
4807f69ab4 Remove duplicate EXLUDE_SYMBOLS 2015-08-26 10:13:04 -07:00
xentec
583f7e9e1c Fix build docs on with newer pip versions
A patch for 3b224e1813
2015-07-26 17:50:18 +02:00
xentec
0586a9e4ea Specify python version in doc build script
Some distros changed their default to python3 causing it to fail.
2015-07-26 17:48:26 +02:00
vitaut
3b224e1813 Fix handling of pip show result when using new version of pip
which returns nonzero error code if the package is not installed.
2015-07-26 08:25:52 -07:00
vitaut
df0835ac27 Update docs 2015-06-26 09:09:23 -07:00
vitaut
761a0afb85 Correct path to doxyxml (#182) and break long line 2015-06-25 06:56:54 -07:00
vitaut
2e874af293 Move CSS compilation to build.py for use by Travis 2015-06-22 06:54:29 -07:00
vitaut
dd6a3bbc7c Fix out-of-tree documentation build (#177) 2015-06-22 06:40:21 -07:00
vitaut
9d09214e7a Use textual representation for bool by default (#170) 2015-06-11 09:00:06 -07:00
vitaut
fd5c2e909b Report error when using precision with char 2015-06-11 08:58:31 -07:00
vitaut
2e254ad19d arg_index -> arg_id 2015-06-10 09:08:49 -07:00
vitaut
4325c155f7 Improve documentation
* Fix formatting in `fmt::arg` apidoc
* Use production syntax instead of regex
* Rename arg_field to arg_id because the term "field" denotes the whole replacement field
* Define `integer`
2015-06-10 07:33:17 -07:00
jamboree
7487bde587 Support named arguments 2015-06-10 09:32:59 +08:00
jamboree
54a6cb34c7 Support runtime width specification 2015-06-04 13:59:37 +08:00
vitaut
d311927c64 Update Breathe and document BasicArrayWriter(Char (&array)[SIZE])
Fixes #125
2015-06-03 18:21:01 -07:00
vitaut
ce5ab7d68f Exclude internal symbols from the docs 2015-05-24 07:48:22 -07:00
vitaut
3310849fa0 Don't use placeholder on the search page 2015-05-23 13:41:21 -07:00
vitaut
f478f7f490 Comment 2015-05-23 13:34:44 -07:00
vitaut
b902efd870 Update classes 2015-05-23 12:48:09 -07:00
vitaut
921f1bae46 .container -> .tb-container (fixes #165) 2015-05-23 12:28:41 -07:00
vitaut
079c6442e1 Fix HTML errors 2015-05-23 11:59:04 -07:00
vitaut
9e83b8a6e0 Move Google analytics block to the top
because according to Google:

One of the main advantages of the asynchronous snippet is that you can position it at the top of the HTML document. This increases the likelihood that the tracking beacon will be sent before the user leaves the page. It is customary to place JavaScript code in the section, and we recommend placing the snippet at the bottom of the section for best performance.
2015-05-23 11:42:57 -07:00
vitaut
e1fcb0a2b5 Remove doctype and add meta tags 2015-05-23 11:38:36 -07:00
vitaut
eaf30d5b0d Move "What users say" to the front page 2015-05-23 08:33:55 -07:00
vitaut
9af6c41684 Use template comments because they are removed from output 2015-05-23 08:31:29 -07:00
vitaut
bfe9267d4d Bootstrapify 2015-05-22 19:21:55 -07:00
vitaut
42001e541e Add basic-bootstrap theme 2015-05-22 19:12:45 -07:00
vitaut
ba994e78ec Use dev instead of version for the development version 2015-05-22 07:50:46 -07:00
vitaut
e4c0046a99 Update documentation links 2015-05-22 06:41:03 -07:00
vitaut
9f60609405 Customize search 2015-05-21 09:03:22 -07:00
vitaut
1456a496f0 Hide the navbar search box on the Search page 2015-05-20 18:22:35 -07:00
vitaut
fca83df599 Support old version of pip installed on Travis, take 2 2015-05-20 11:45:16 -07:00
vitaut
6955417236 Support old version of pip installed on Travis 2015-05-20 11:10:16 -07:00
vitaut
f9936c4859 Build docs on travis 2015-05-20 08:06:12 -07:00
vitaut
abba1477a7 Remove duplicate namespace 2015-05-19 18:38:21 -07:00
vitaut
183ce52c41 Improve style 2015-05-19 18:20:27 -07:00
vitaut
86aa72f3d5 Fixed unresolved references 2015-05-19 18:04:32 -07:00
vitaut
0ba61ffa6d Improve style 2015-05-19 17:58:04 -07:00
vitaut
c17f4ec099 Make sure the navbar content is not shifted because of scrollbars
https://github.com/twbs/bootstrap/issues/1648
2015-05-19 08:30:16 -07:00
vitaut
56d5335e3f Merge branch 'master' of github.com:cppformat/cppformat 2015-05-19 08:13:29 -07:00
vitaut
18a55cdb27 Customize Sphinx theme 2015-05-19 08:13:13 -07:00
vitaut
4c1a0303aa Create and keep virtualenv in the current (build) directory 2015-05-18 08:09:26 -07:00
vitaut
0e28acdd05 Update Sphinx to 1.3.1 to fix local search 2015-05-18 07:24:33 -07:00
Syohei YOSHIDA
0ba03ee823 Correct misspellings 2015-05-15 15:57:22 +09:00
vitaut
f3fc8052ab Add a section on how to install the library using Homebrew
Thanks to @ortho for adding C++ Format support to Homebrew.
2015-05-08 08:19:15 -07:00
vitaut
fde90aa551 Move license to a separate file
This is done to follow Fedora guidelines:
https://fedoraproject.org/wiki/Packaging:LicensingGuidelines#License_Text

Also rename the Python license used in the docs to python-license.txt to
avoid confusing extension.
2015-05-07 06:43:13 -07:00
vitaut
8c24a42395 Make documentation builds more reproducible by using virtualenv 2015-04-10 08:39:09 -07:00
vitaut
d2ada77ccc Install documentation 2015-04-09 07:21:42 -07:00
vitaut
45bba4f129 Document protected members of Buffer 2015-03-20 06:46:39 -07:00
vitaut
73ea170966 Document the Buffer class 2015-03-20 06:42:55 -07:00
Victor Zverovich
6af3da1089 Merge website content into docs 2015-03-09 07:37:27 -07:00
Victor Zverovich
8abc15f85e Fix a reference 2015-03-04 14:04:10 -08:00
Victor Zverovich
f1e77e41a5 Update breathe 2015-03-02 08:34:22 -08:00
Victor Zverovich
91a7ee6c20 Add BasicArrayWriter to docs 2015-03-01 18:10:09 -08:00
Victor Zverovich
c3e845ab7e Only enable doc target if breathe is available 2015-03-01 16:35:29 -08:00
Victor Zverovich
040b8e7e06 Link to Android NDK 2015-02-16 07:25:45 -08:00
Victor Zverovich
d9ef0e0a44 Minor correction 2015-02-16 07:11:57 -08:00
Victor Zverovich
291e43abac Add Android NDK section 2015-02-16 07:09:25 -08:00
Victor Zverovich
83f5085551 Remove RTD theme 2015-02-06 09:01:49 -08:00
Victor Zverovich
bc6fcd90cf Fix CSS 2015-02-05 08:41:19 -08:00
Victor Zverovich
402f5f3178 Documentation fixes 2015-02-05 08:36:46 -08:00
Victor Zverovich
b4eef59100 Only add the doc target if doxygen and sphinx-build are available 2015-01-30 12:53:52 -08:00
Victor Zverovich
90bc8dd3ed Don't track the dependencies of the doc target as Sphinx does it itself 2015-01-30 08:49:48 -08:00
Victor Zverovich
237eaa53e1 Replace exclude_trees with exclude_patterns
exclude_trees was removed in Sphinx 1.3b1
2015-01-30 07:15:00 -08:00
Victor Zverovich
43aebf51d6 Allow precision specifier for non-float arguments 2015-01-08 07:56:08 -08:00
Victor Zverovich
a7d7e0daec Restore bootstrap theme 2014-12-19 07:42:46 -08:00
Victor Zverovich
fdecd5b40f Remove FMT_SHARED in favor of BUILD_SHARED_LIBS 2014-12-19 07:37:49 -08:00
Victor Zverovich
a8b1769803 Use default namespace 2014-12-18 08:46:25 -08:00
Victor Zverovich
8d89e56d2c Set primary domain to cpp 2014-12-18 08:36:53 -08:00
Victor Zverovich
97ea39cf79 Remove no longer needed highlight directives 2014-11-07 07:26:04 -08:00
Victor Zverovich
43d3c0a110 Set highlight language to c++ in config 2014-11-07 07:24:51 -08:00
Victor Zverovich
6527551d43 Simplify markup 2014-11-05 07:39:34 -08:00
Victor Zverovich
10698cc44d Update theme 2014-11-04 08:31:07 -08:00
Victor Zverovich
aa78f6155b Add theme alias 2014-11-04 08:17:59 -08:00
Victor Zverovich
8f93e84a1a Switch to ReadTheDocs theme 2014-11-04 07:37:25 -08:00
Victor Zverovich
9501ca0e68 Update theme 2014-10-24 07:43:53 -07:00
Victor Zverovich
c50e7781fc Remove old bootstrap theme 2014-10-24 07:09:46 -07:00
Victor Zverovich
e3263a341e Update theme 2014-10-23 07:25:54 -07:00
Victor Zverovich
adca25913c Indent descriptions of macros 2014-10-23 07:22:37 -07:00
Victor Zverovich
99ff512b32 Use sphinx bootstrap theme from subproject 2014-10-23 07:17:56 -07:00
Victor Zverovich
0019793786 Add bootstrap theme as a module 2014-10-21 08:28:27 -07:00
Victor Zverovich
e640e458c1 Align navbar content with the main content 2014-10-20 08:56:27 -07:00
Victor Zverovich
fb6ed7590b Align footer with the main content 2014-10-17 09:39:43 -07:00
Victor Zverovich
e9bf788bd5 Add side margins if screen is too wide 2014-10-17 09:20:21 -07:00
Victor Zverovich
4a818ac785 Move CSS override to theme because RTD ignores layout.html
RTD bug: https://github.com/rtfd/readthedocs.org/issues/152
2014-10-17 09:15:47 -07:00
Victor Zverovich
c90c6805a2 Add side margins if screen is too wide 2014-10-17 07:53:56 -07:00
Victor Zverovich
7d2c3ac0f2 Add styles 2014-10-17 07:24:49 -07:00
Victor Zverovich
32392597aa Move Usage section to a separate file 2014-10-16 07:12:43 -07:00
Victor Zverovich
88f3f53870 Fix Sphinx config 2014-10-10 08:47:36 -07:00
Victor Zverovich
709465197a Switch to bootstrap theme 2014-10-10 08:40:35 -07:00
Victor Zverovich
76a2ea56ce Add bootstrap Sphinx theme 2014-10-10 08:39:54 -07:00
Victor Zverovich
a7520f164a Restore theme 2014-10-10 06:18:50 -07:00
Victor Zverovich
bb1926753d Try using the default theme 2014-10-10 06:10:52 -07:00
Victor Zverovich
f05e856017 Fix example 2014-10-09 11:25:39 -07:00
Victor Zverovich
8cab5909e0 Improve PDF output 2014-10-09 07:57:26 -07:00
Victor Zverovich
80f5cbb9e5 Add missing quote 2014-10-09 07:57:03 -07:00
Victor Zverovich
55c61d1abd Update project name 2014-10-06 08:27:42 -07:00
Victor Zverovich
ae413ebf7a Add a section on custom allocators 2014-10-01 08:49:20 -07:00
Victor Zverovich
04d38a8b14 Update docs 2014-10-01 08:32:01 -07:00
Victor Zverovich
13bbb0db7a Update docs 2014-09-21 14:12:21 -07:00
Victor Zverovich
3269fce2dc Fix https://github.com/cppformat/cppformat/issues/61 2014-09-12 08:27:23 -07:00
Victor Zverovich
108cd1d1a0 Fix anchor. 2014-08-28 10:18:13 -07:00