Commit Graph

325 Commits

Author SHA1 Message Date
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
Victor Zverovich
45397e5046 Add dependency from CMakeLists.txt since it is used to get version. 2014-08-21 08:51:45 -07:00
Victor Zverovich
dd4323f31c Add fprintf and write docs. 2014-08-21 08:49:13 -07:00
Victor Zverovich
f9561671cf Write docs. 2014-08-21 07:30:00 -07:00
Victor Zverovich
4c563de76f Use stock version of sphinx build. 2014-07-27 10:07:20 -07:00
Victor Zverovich
33cde15334 Fix version. 2014-07-26 21:23:50 -07:00
Victor Zverovich
533b9cf24f Add missing import. 2014-07-26 21:14:40 -07:00
Victor Zverovich
46b6e4b52c Run doxygen on ReadTheDocs. 2014-07-26 21:12:48 -07:00
Victor Zverovich
d91a66e1c5 Read version from CMakeLists.txt instead of using configure for compatibility with ReadTheDocs. 2014-07-26 21:05:42 -07:00
Victor Zverovich
530479bd07 Don't exclude PrepareBufferForInt to demonstrate an issue with docs. 2014-07-01 13:12:44 -07:00
Victor Zverovich
14e7ed76df Update excludes. 2014-06-30 15:43:46 -07:00
Victor Zverovich
53201033f2 Refactor error reporting API. 2014-06-30 14:26:29 -07:00
Victor Zverovich
9d5905707a Update docs. 2014-06-29 11:51:27 -07:00
Victor Zverovich
91e6bc8b97 Document 'a' and 'A' format specifiers. 2014-06-23 07:28:29 -07:00
Victor Zverovich
5e6f57ada1 Link to the latest release. 2014-06-21 09:11:19 -07:00
Victor Zverovich
680d88de68 Add Usage section. 2014-06-21 08:50:48 -07:00
Victor Zverovich
f8c058e99c Predefine _WIN32 for Windows-only parts of API. 2014-06-21 08:18:24 -07:00
Victor Zverovich
13a5b2511b Document Print. 2014-05-18 10:04:36 -07:00
Victor Zverovich
d2e7554f74 Write docs. 2014-05-14 07:29:47 -07:00
Victor Zverovich
3303708e94 Document ThrowSystemError and ThrowWinError. 2014-05-14 07:05:09 -07:00
Victor Zverovich
83920084f7 Update docs. 2014-05-13 08:55:13 -07:00
Victor Zverovich
891da2f474 Fix docs. 2014-05-13 07:39:18 -07:00
Victor Zverovich
089e54a09b Fix docs. 2014-05-13 07:35:46 -07:00
Victor Zverovich
660938fe4d Add sphinx and breathe at top level. 2014-05-13 07:32:28 -07:00
Victor Zverovich
b0728fed27 Remove sphinx submodule. 2014-05-13 07:30:04 -07:00
Victor Zverovich
b9fbdadf75 Update names in the docs. 2014-05-13 06:15:43 -07:00
Victor Zverovich
6cb7f4638d Generate docs for variadic templates. 2014-05-13 06:15:33 -07:00
Victor Zverovich
76d9a103e1 Update dependencies. 2014-05-13 06:15:18 -07:00
Victor Zverovich
0c13c4483b Add custom version of sphinx and move breathe to doc. 2014-05-13 06:13:21 -07:00
Victor Zverovich
028fb01f42 Make docs depend on layout. 2014-04-22 06:34:31 -07:00
Victor Zverovich
cdfbd128ec Document namespace use. 2014-04-19 19:17:06 -07:00
Victor Zverovich
c22c26ed3d Update project name, copyright and version. 2014-04-17 08:55:02 -07:00
Victor Zverovich
5ef5195c8f Add Google Analytics. 2014-04-16 12:24:35 -07:00
Victor Zverovich
17fbcd166f Change String Formatting API to C++ Format Library API as it supports more general things than string formatting, e.g. file I/O. 2014-04-14 14:42:43 -07:00
Victor Zverovich
10b2fe0f27 Implement packaging. 2014-04-14 12:54:03 -07:00
Victor Zverovich
be69339bc8 Bump version 2013-12-10 08:50:46 -08:00
Victor Zverovich
04c2b05340 Add fmt::bin to the docs. Separate integer type specifiers because the list of types is too long. 2013-11-19 08:57:15 -08:00
Victor Zverovich
4f3ae78adb Fix formatting. 2013-11-16 21:15:37 -08:00
Victor Zverovich
93ca4c98fe Document the 'B' type and the difference between 'b' & 'B'. Addresses part of issue https://github.com/vitaut/format/issues/5 2013-11-16 21:09:46 -08:00
Victor Zverovich
0563aca180 Document that "#x" adds prefix "0x" and "#X" adds "0X". Addresses part of issue https://github.com/vitaut/format/issues/5 2013-11-16 21:06:07 -08:00
Gregory Czajkowski
c5695691c1 add support for bin formatter 2013-11-12 14:06:43 -08:00
Gregory Czajkowski
e4ffc06875 add support for binary type and test long longs more 2013-10-23 20:04:32 -07:00
Victor Zverovich
1e724a9d33 Write docs. 2013-09-08 15:37:14 -07:00
Victor Zverovich
6d33ce9f81 Bump version. 2013-09-04 20:59:54 -07:00
Victor Zverovich
3a7962fc1b Update the docs. 2013-09-04 20:44:13 -07:00
Victor Zverovich
9aa5b7ecd4 Update the docs. 2013-09-04 19:31:22 -07:00
Victor Zverovich
3638eeee62 Formatter -> BasicFormatter 2013-04-27 06:34:33 -07:00
Victor Zverovich
309a51c2ad Bump version. 2013-02-05 08:16:24 -08:00
Victor Zverovich
dbfd021ae2 Document the write API. 2013-01-22 11:06:56 -08:00
Victor Zverovich
a1dccea9ba Use one namespace (fmt) instead of two (format and fmt). 2013-01-21 11:42:25 -08:00
Victor Zverovich
8598a57693 Rename "String Formatting" section to "String Formatting API". 2013-01-15 07:17:11 -08:00
Victor Zverovich
d974a935d5 rename format.rst to index.rst 2013-01-14 06:57:44 -08:00
Victor Zverovich
a99e7a2bae remove index.rst 2013-01-14 06:57:21 -08:00
Victor Zverovich
de580f6930 Move str and c_str to the fmt namespace and document the API. 2013-01-13 07:50:28 -08:00
Victor Zverovich
aba9e15021 Add support for types other than int in oct, hex, hexu & pad. Document the API. 2013-01-13 07:14:54 -08:00
Victor Zverovich
9e81263cf5 Document the API. 2013-01-12 10:08:39 -08:00
Victor Zverovich
8e158d74cd Document the API. 2013-01-04 07:04:35 -08:00
Victor Zverovich
00830b99b3 Document the API using breathe. 2013-01-03 08:57:34 -08:00
Victor Zverovich
5ec28a4914 Use breathe + doxygen for API documentation. 2012-12-29 09:27:26 -08:00
Victor Zverovich
a4f836e325 Add missing ')'. 2012-12-28 06:42:17 -08:00
Victor Zverovich
8412ad6aeb Implement automatic argument indexing. 2012-12-27 06:56:55 -08:00
Victor Zverovich
c5f4ecb25a . 2012-12-21 22:50:51 -08:00
Victor Zverovich
a145b4c61c Correct module name. 2012-12-19 09:17:32 -08:00
Victor Zverovich
b1da947d75 Preserve original copyright. 2012-12-19 09:17:20 -08:00
Victor Zverovich
45865de9b4 string.rst -> format.rst 2012-12-19 09:06:32 -08:00
Victor Zverovich
bee2b6a5ac Update doc. 2012-12-19 09:05:07 -08:00
Victor Zverovich
2e6d79a523 Update docs. 2012-12-18 09:27:07 -08:00
Victor Zverovich
d7db2657a0 "positional argument" -> argument (in C++ all arguments are positional in a sense, there are no keyword arguments). 2012-12-18 08:46:53 -08:00
Victor Zverovich
2a95e670e5 Adapt "Format String Syntax" for the format library. 2012-12-18 08:41:59 -08:00
Victor Zverovich
a658427bbf Temporary disabled String Formatting part. Get rid of "conversion". 2012-12-18 07:15:15 -08:00
Victor Zverovich
c1ca4a4574 Add docs. 2012-12-18 06:49:18 -08:00