diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index 10c04cdc..83b78a4c 100644 --- a/docs/_sources/index.txt +++ b/docs/_sources/index.txt @@ -1,22 +1,69 @@ -.. Sprout documentation master file, created by - sphinx-quickstart on Thu Aug 15 11:33:13 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Sprout's documentation! -================================== - -Contents: +.. _sprout: +############################################################################### +Sprout C++ Libraries +############################################################################### .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - libs/index + libs/index -Indices and tables -================== +.. _sprout-welcome: +******************************************************************************* +Welcome to the Sprout C++ Libraries +******************************************************************************* -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +| C++11 constexpr based Containers, Algorithms, Random numbers, Parsing, Ray tracing, Synthesizer, and others. + +.. _sprout-documentation: +******************************************************************************* +Library Documentation +******************************************************************************* + +| The starting point for the documentation of individual libraries is the :doc:`Libraries page <./libs/index>`, which gives a brief description of each library and links to its documentation. +| + +.. _sprout-project: +******************************************************************************* +Project page +******************************************************************************* + +* `Project page `_ +* `Repository (Github) `_ +* `Wiki (japanese) `_ + +.. _sprout-install: +******************************************************************************* +Install +******************************************************************************* + +| Through the path to the directory. ``/path/to/sprout`` +| This library can be used in the header only. + +.. _sprout-compilers: +******************************************************************************* +Supported Compilers +******************************************************************************* + +Linux: + +* GCC, C++11 mode: 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.8.0, 4.8.1 +* Clang, C++11 mode: 3.2, 3.3 + +.. _sprout-author: +******************************************************************************* +Author +******************************************************************************* + +| Bolero MURAKAMI `(Mail) `_ +| `[Website] `_ `[Twitter] `_ `[Facebook] `_ `[Blog] `_ `[Github] `_ `[SlideShare] `_ + +.. _sprout-copyrights: +******************************************************************************* +Copyrights +******************************************************************************* + +| Copyright (C) 2011-2013 Bolero MURAKAMI. +| Distributed under the Boost Software License, Version 1.0. +| (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) diff --git a/docs/_sources/libs/sprout/algorithm/adjacent_find.txt b/docs/_sources/libs/algorithm/adjacent_find.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/adjacent_find.txt rename to docs/_sources/libs/algorithm/adjacent_find.txt diff --git a/docs/_sources/libs/sprout/algorithm/all_of.txt b/docs/_sources/libs/algorithm/all_of.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/all_of.txt rename to docs/_sources/libs/algorithm/all_of.txt diff --git a/docs/_sources/libs/sprout/algorithm/all_of_equal.txt b/docs/_sources/libs/algorithm/all_of_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/all_of_equal.txt rename to docs/_sources/libs/algorithm/all_of_equal.txt diff --git a/docs/_sources/libs/sprout/algorithm/any_of.txt b/docs/_sources/libs/algorithm/any_of.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/any_of.txt rename to docs/_sources/libs/algorithm/any_of.txt diff --git a/docs/_sources/libs/sprout/algorithm/any_of_equal.txt b/docs/_sources/libs/algorithm/any_of_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/any_of_equal.txt rename to docs/_sources/libs/algorithm/any_of_equal.txt diff --git a/docs/_sources/libs/sprout/algorithm/binary_search.txt b/docs/_sources/libs/algorithm/binary_search.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/binary_search.txt rename to docs/_sources/libs/algorithm/binary_search.txt diff --git a/docs/_sources/libs/sprout/algorithm/clamp.txt b/docs/_sources/libs/algorithm/clamp.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/clamp.txt rename to docs/_sources/libs/algorithm/clamp.txt diff --git a/docs/_sources/libs/sprout/algorithm/count.txt b/docs/_sources/libs/algorithm/count.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/count.txt rename to docs/_sources/libs/algorithm/count.txt diff --git a/docs/_sources/libs/sprout/algorithm/count_if.txt b/docs/_sources/libs/algorithm/count_if.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/count_if.txt rename to docs/_sources/libs/algorithm/count_if.txt diff --git a/docs/_sources/libs/sprout/algorithm/equal.txt b/docs/_sources/libs/algorithm/equal.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/equal.txt rename to docs/_sources/libs/algorithm/equal.txt diff --git a/docs/_sources/libs/sprout/algorithm/equal_range.txt b/docs/_sources/libs/algorithm/equal_range.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/equal_range.txt rename to docs/_sources/libs/algorithm/equal_range.txt diff --git a/docs/_sources/libs/sprout/algorithm/find.txt b/docs/_sources/libs/algorithm/find.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/find.txt rename to docs/_sources/libs/algorithm/find.txt diff --git a/docs/_sources/libs/sprout/algorithm/find_end.txt b/docs/_sources/libs/algorithm/find_end.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/find_end.txt rename to docs/_sources/libs/algorithm/find_end.txt diff --git a/docs/_sources/libs/sprout/algorithm/find_first_of.txt b/docs/_sources/libs/algorithm/find_first_of.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/find_first_of.txt rename to docs/_sources/libs/algorithm/find_first_of.txt diff --git a/docs/_sources/libs/sprout/algorithm/find_if.txt b/docs/_sources/libs/algorithm/find_if.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/find_if.txt rename to docs/_sources/libs/algorithm/find_if.txt diff --git a/docs/_sources/libs/sprout/algorithm/find_if_not.txt b/docs/_sources/libs/algorithm/find_if_not.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/find_if_not.txt rename to docs/_sources/libs/algorithm/find_if_not.txt diff --git a/docs/_sources/libs/sprout/algorithm/index.txt b/docs/_sources/libs/algorithm/index.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/index.txt rename to docs/_sources/libs/algorithm/index.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_decreasing.txt b/docs/_sources/libs/algorithm/is_decreasing.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_decreasing.txt rename to docs/_sources/libs/algorithm/is_decreasing.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_heap.txt b/docs/_sources/libs/algorithm/is_heap.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_heap.txt rename to docs/_sources/libs/algorithm/is_heap.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_heap_until.txt b/docs/_sources/libs/algorithm/is_heap_until.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_heap_until.txt rename to docs/_sources/libs/algorithm/is_heap_until.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_increasing.txt b/docs/_sources/libs/algorithm/is_increasing.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_increasing.txt rename to docs/_sources/libs/algorithm/is_increasing.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_permutation.txt b/docs/_sources/libs/algorithm/is_permutation.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_permutation.txt rename to docs/_sources/libs/algorithm/is_permutation.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_sorted.txt b/docs/_sources/libs/algorithm/is_sorted.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_sorted.txt rename to docs/_sources/libs/algorithm/is_sorted.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_sorted_until.txt b/docs/_sources/libs/algorithm/is_sorted_until.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_sorted_until.txt rename to docs/_sources/libs/algorithm/is_sorted_until.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_strictly_decreasing.txt b/docs/_sources/libs/algorithm/is_strictly_decreasing.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_strictly_decreasing.txt rename to docs/_sources/libs/algorithm/is_strictly_decreasing.txt diff --git a/docs/_sources/libs/sprout/algorithm/is_strictly_increasing.txt b/docs/_sources/libs/algorithm/is_strictly_increasing.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/is_strictly_increasing.txt rename to docs/_sources/libs/algorithm/is_strictly_increasing.txt diff --git a/docs/_sources/libs/sprout/algorithm/lexicographical_compare.txt b/docs/_sources/libs/algorithm/lexicographical_compare.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/lexicographical_compare.txt rename to docs/_sources/libs/algorithm/lexicographical_compare.txt diff --git a/docs/_sources/libs/sprout/algorithm/lower_bound.txt b/docs/_sources/libs/algorithm/lower_bound.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/lower_bound.txt rename to docs/_sources/libs/algorithm/lower_bound.txt diff --git a/docs/_sources/libs/sprout/algorithm/max.txt b/docs/_sources/libs/algorithm/max.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/max.txt rename to docs/_sources/libs/algorithm/max.txt diff --git a/docs/_sources/libs/sprout/algorithm/max_element.txt b/docs/_sources/libs/algorithm/max_element.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/max_element.txt rename to docs/_sources/libs/algorithm/max_element.txt diff --git a/docs/_sources/libs/sprout/algorithm/min.txt b/docs/_sources/libs/algorithm/min.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/min.txt rename to docs/_sources/libs/algorithm/min.txt diff --git a/docs/_sources/libs/sprout/algorithm/min_element.txt b/docs/_sources/libs/algorithm/min_element.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/min_element.txt rename to docs/_sources/libs/algorithm/min_element.txt diff --git a/docs/_sources/libs/sprout/algorithm/minmax.txt b/docs/_sources/libs/algorithm/minmax.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/minmax.txt rename to docs/_sources/libs/algorithm/minmax.txt diff --git a/docs/_sources/libs/sprout/algorithm/minmax_element.txt b/docs/_sources/libs/algorithm/minmax_element.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/minmax_element.txt rename to docs/_sources/libs/algorithm/minmax_element.txt diff --git a/docs/_sources/libs/sprout/algorithm/mismatch.txt b/docs/_sources/libs/algorithm/mismatch.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/mismatch.txt rename to docs/_sources/libs/algorithm/mismatch.txt diff --git a/docs/_sources/libs/sprout/algorithm/none_of.txt b/docs/_sources/libs/algorithm/none_of.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/none_of.txt rename to docs/_sources/libs/algorithm/none_of.txt diff --git a/docs/_sources/libs/sprout/algorithm/none_of_equal.txt b/docs/_sources/libs/algorithm/none_of_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/none_of_equal.txt rename to docs/_sources/libs/algorithm/none_of_equal.txt diff --git a/docs/_sources/libs/sprout/algorithm/one_of.txt b/docs/_sources/libs/algorithm/one_of.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/one_of.txt rename to docs/_sources/libs/algorithm/one_of.txt diff --git a/docs/_sources/libs/sprout/algorithm/one_of_equal.txt b/docs/_sources/libs/algorithm/one_of_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/one_of_equal.txt rename to docs/_sources/libs/algorithm/one_of_equal.txt diff --git a/docs/_sources/libs/sprout/algorithm/search.txt b/docs/_sources/libs/algorithm/search.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/search.txt rename to docs/_sources/libs/algorithm/search.txt diff --git a/docs/_sources/libs/sprout/algorithm/search_n.txt b/docs/_sources/libs/algorithm/search_n.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/search_n.txt rename to docs/_sources/libs/algorithm/search_n.txt diff --git a/docs/_sources/libs/sprout/algorithm/tristate_lexicographical_compare.txt b/docs/_sources/libs/algorithm/tristate_lexicographical_compare.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/tristate_lexicographical_compare.txt rename to docs/_sources/libs/algorithm/tristate_lexicographical_compare.txt diff --git a/docs/_sources/libs/sprout/algorithm/upper_bound.txt b/docs/_sources/libs/algorithm/upper_bound.txt similarity index 100% rename from docs/_sources/libs/sprout/algorithm/upper_bound.txt rename to docs/_sources/libs/algorithm/upper_bound.txt diff --git a/docs/_sources/libs/sprout/array/array/assign.txt b/docs/_sources/libs/array/array/assign.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/assign.txt rename to docs/_sources/libs/array/array/assign.txt diff --git a/docs/_sources/libs/sprout/array/array/at.txt b/docs/_sources/libs/array/array/at.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/at.txt rename to docs/_sources/libs/array/array/at.txt diff --git a/docs/_sources/libs/sprout/array/array/back.txt b/docs/_sources/libs/array/array/back.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/back.txt rename to docs/_sources/libs/array/array/back.txt diff --git a/docs/_sources/libs/sprout/array/array/begin.txt b/docs/_sources/libs/array/array/begin.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/begin.txt rename to docs/_sources/libs/array/array/begin.txt diff --git a/docs/_sources/libs/sprout/array/array/c_array.txt b/docs/_sources/libs/array/array/c_array.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/c_array.txt rename to docs/_sources/libs/array/array/c_array.txt diff --git a/docs/_sources/libs/sprout/array/array/cbegin.txt b/docs/_sources/libs/array/array/cbegin.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/cbegin.txt rename to docs/_sources/libs/array/array/cbegin.txt diff --git a/docs/_sources/libs/sprout/array/array/cend.txt b/docs/_sources/libs/array/array/cend.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/cend.txt rename to docs/_sources/libs/array/array/cend.txt diff --git a/docs/_sources/libs/sprout/array/array/crbegin.txt b/docs/_sources/libs/array/array/crbegin.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/crbegin.txt rename to docs/_sources/libs/array/array/crbegin.txt diff --git a/docs/_sources/libs/sprout/array/array/crend.txt b/docs/_sources/libs/array/array/crend.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/crend.txt rename to docs/_sources/libs/array/array/crend.txt diff --git a/docs/_sources/libs/sprout/array/array/data.txt b/docs/_sources/libs/array/array/data.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/data.txt rename to docs/_sources/libs/array/array/data.txt diff --git a/docs/_sources/libs/sprout/array/array/empty.txt b/docs/_sources/libs/array/array/empty.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/empty.txt rename to docs/_sources/libs/array/array/empty.txt diff --git a/docs/_sources/libs/sprout/array/array/end.txt b/docs/_sources/libs/array/array/end.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/end.txt rename to docs/_sources/libs/array/array/end.txt diff --git a/docs/_sources/libs/sprout/array/array/fill.txt b/docs/_sources/libs/array/array/fill.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/fill.txt rename to docs/_sources/libs/array/array/fill.txt diff --git a/docs/_sources/libs/sprout/array/array/front.txt b/docs/_sources/libs/array/array/front.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/front.txt rename to docs/_sources/libs/array/array/front.txt diff --git a/docs/_sources/libs/sprout/array/array/index.txt b/docs/_sources/libs/array/array/index.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/index.txt rename to docs/_sources/libs/array/array/index.txt diff --git a/docs/_sources/libs/sprout/array/array/initializer-.txt b/docs/_sources/libs/array/array/initializer-.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/initializer-.txt rename to docs/_sources/libs/array/array/initializer-.txt diff --git a/docs/_sources/libs/sprout/array/array/max_size.txt b/docs/_sources/libs/array/array/max_size.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/max_size.txt rename to docs/_sources/libs/array/array/max_size.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-assign.txt b/docs/_sources/libs/array/array/operator-assign.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-assign.txt rename to docs/_sources/libs/array/array/operator-assign.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-equal_to.txt b/docs/_sources/libs/array/array/operator-equal_to.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-equal_to.txt rename to docs/_sources/libs/array/array/operator-equal_to.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-greater.txt b/docs/_sources/libs/array/array/operator-greater.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-greater.txt rename to docs/_sources/libs/array/array/operator-greater.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-greater_equal.txt b/docs/_sources/libs/array/array/operator-greater_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-greater_equal.txt rename to docs/_sources/libs/array/array/operator-greater_equal.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-less.txt b/docs/_sources/libs/array/array/operator-less.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-less.txt rename to docs/_sources/libs/array/array/operator-less.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-less_equal.txt b/docs/_sources/libs/array/array/operator-less_equal.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-less_equal.txt rename to docs/_sources/libs/array/array/operator-less_equal.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-not_equal_to.txt b/docs/_sources/libs/array/array/operator-not_equal_to.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-not_equal_to.txt rename to docs/_sources/libs/array/array/operator-not_equal_to.txt diff --git a/docs/_sources/libs/sprout/array/array/operator-subscript.txt b/docs/_sources/libs/array/array/operator-subscript.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/operator-subscript.txt rename to docs/_sources/libs/array/array/operator-subscript.txt diff --git a/docs/_sources/libs/sprout/array/array/rbegin.txt b/docs/_sources/libs/array/array/rbegin.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/rbegin.txt rename to docs/_sources/libs/array/array/rbegin.txt diff --git a/docs/_sources/libs/sprout/array/array/rend.txt b/docs/_sources/libs/array/array/rend.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/rend.txt rename to docs/_sources/libs/array/array/rend.txt diff --git a/docs/_sources/libs/sprout/array/array/size.txt b/docs/_sources/libs/array/array/size.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/size.txt rename to docs/_sources/libs/array/array/size.txt diff --git a/docs/_sources/libs/sprout/array/array/swap-global.txt b/docs/_sources/libs/array/array/swap-global.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/swap-global.txt rename to docs/_sources/libs/array/array/swap-global.txt diff --git a/docs/_sources/libs/sprout/array/array/swap.txt b/docs/_sources/libs/array/array/swap.txt similarity index 100% rename from docs/_sources/libs/sprout/array/array/swap.txt rename to docs/_sources/libs/array/array/swap.txt diff --git a/docs/_sources/libs/sprout/array/index.txt b/docs/_sources/libs/array/index.txt similarity index 100% rename from docs/_sources/libs/sprout/array/index.txt rename to docs/_sources/libs/array/index.txt diff --git a/docs/_sources/libs/sprout/array/make_array.txt b/docs/_sources/libs/array/make_array.txt similarity index 100% rename from docs/_sources/libs/sprout/array/make_array.txt rename to docs/_sources/libs/array/make_array.txt diff --git a/docs/_sources/libs/sprout/array/make_common_array.txt b/docs/_sources/libs/array/make_common_array.txt similarity index 100% rename from docs/_sources/libs/sprout/array/make_common_array.txt rename to docs/_sources/libs/array/make_common_array.txt diff --git a/docs/_sources/libs/sprout/array/to_array.txt b/docs/_sources/libs/array/to_array.txt similarity index 100% rename from docs/_sources/libs/sprout/array/to_array.txt rename to docs/_sources/libs/array/to_array.txt diff --git a/docs/_sources/libs/index.txt b/docs/_sources/libs/index.txt index f05475b7..0799d2cf 100644 --- a/docs/_sources/libs/index.txt +++ b/docs/_sources/libs/index.txt @@ -1,69 +1,130 @@ -.. _sprout: +.. _sprout-libraries: ############################################################################### -Sprout C++ Libraries +Libraries ############################################################################### .. toctree:: - :maxdepth: 1 + :hidden: - libraries + array/index + algorithm/index -.. _sprout-welcome: +.. _sprout-listed_by_alphabetically: ******************************************************************************* -Welcome to the Sprout C++ Libraries +Libraries Listed Alphabetically ******************************************************************************* -| C++11 constexpr based Containers, Algorithms, Random numbers, Parsing, Ray tracing, Synthesizer, and others. +* :doc:`algorithm <./algorithm/index>` - Standard library like generic algorithms. +* :doc:`array <./array/index>` - Standard library compliant class template for storing fixed-size sequences of objects. -.. _sprout-documentation: +.. _sprout-listed_by_category: ******************************************************************************* -Library Documentation +Libraries Listed by Category ******************************************************************************* -| The starting point for the documentation of individual libraries is the :doc:`Libraries page <./libraries>`, which gives a brief description of each library and links to its documentation. -| +.. _sprout-listed_by_category-containers: +Containers and Data structures +======================================= -.. _sprout-project: -******************************************************************************* -Project page -******************************************************************************* +* :doc:`array <./array/index>` - Standard library compliant class template for storing fixed-size sequences of objects. +* :doc:`string <./string/index>` - Compile-time string of fixed-length buffer. +* :doc:`tuple <./tuple/index>` +* :doc:`optional <./optional/index>` +* :doc:`variant <./variant/index>` +* :doc:`bitset <./bitset/index>` -* `Project page `_ -* `Repository (Github) `_ -* `Wiki (japanese) `_ +.. _sprout-listed_by_category-algorithms: +Algorithms +======================================= -.. _sprout-install: -******************************************************************************* -Install -******************************************************************************* +* :doc:`algorithm <./algorithm/index>` - Standard library like generic algorithms. +* :doc:`numeric <./numeric/index>` +* :doc:`range_algorithm <./range/algorithm/index>` +* :doc:`range_numeric <./range/numeric/index>` +* :doc:`range_adaptor <./range/adaptor/index>` -| Through the path to the directory. ``/path/to/sprout`` -| This library can be used in the header only. +.. _sprout-listed_by_category-container_supports: +Container supports +======================================= -.. _sprout-compilers: -******************************************************************************* -Supported Compilers -******************************************************************************* +* :doc:`sub_array <./sub_array/index>` +* :doc:`pit <./pit/index>` +* :doc:`operation <./operation/index>` +* :doc:`container <./container/index>` -Linux: +.. _sprout-listed_by_category-function_objects: +Function Objects +======================================= -* GCC, C++11 mode: 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.8.0, 4.8.1 -* Clang, C++11 mode: 3.2, 3.3 +* :doc:`functional <./functional/index>` -.. _sprout-author: -******************************************************************************* -Author -******************************************************************************* +.. _sprout-listed_by_category-iterators: +Iterators +======================================= -| Bolero MURAKAMI `(Mail) `_ -| `[Website] `_ `[Twitter] `_ `[Facebook] `_ `[Blog] `_ `[Github] `_ `[SlideShare] `_ +* :doc:`iterator <./iterator/index>` -.. _sprout-copyrights: -******************************************************************************* -Copyrights -******************************************************************************* +.. _sprout-listed_by_category-mathematics: +Mathematics +======================================= -| Copyright (C) 2011-2013 Bolero MURAKAMI. -| Distributed under the Boost Software License, Version 1.0. -| (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +* :doc:`math_functions <./math_functions/index>` +* :doc:`random <./random/index>` +* :doc:`complex <./complex/index>` +* :doc:`rational <./rational/index>` +.. _sprout-listed_by_category-template_metaprogramming: +Template Metaprogramming +======================================= + +* :doc:`index_tuple <./index_tuple/index>` +* :doc:`type_traits <./type_traits/index>` +* :doc:`type <./type/index>` + +.. _sprout-listed_by_category-preprocessor_metaprogramming: +Preprocessor Metaprogramming +======================================= + +* :doc:`preprocessor <./preprocessor/index>` + +.. _sprout-listed_by_category-domain_specific: +Domain specific +======================================= + +* :doc:`uuid <./uuid/index>` +* :doc:`checksum <./checksum/index>` + +.. _sprout-listed_by_category-parsing: +Parsing +======================================= + +* :doc:`weed <./weed/index>` + +.. _sprout-listed_by_category-ray_tracing: +Ray tracing +======================================= + +* :doc:`darkroom <./darkroom/index>` + +.. _sprout-listed_by_category-synthesizer: +Synthesizer +======================================= + +* :doc:`compost <./compost/index>` + +.. _sprout-listed_by_category-miscellaneous: +Miscellaneous +======================================= + +* :doc:`utility <./utility/index>` +* :doc:`bit_operation <./bit_operation/index>` + +.. _sprout-listed_by_category-c-compatible: +C-compatible +======================================= + +* :doc:`cstdlib <./cstdlib/index>` +* :doc:`cstring <./cstring/index>` +* :doc:`cwchar <./cwchar/index>` +* :doc:`cctype <./cctype/index>` +* :doc:`cinttypes <./cinttypes/index>` diff --git a/docs/_sources/libs/libraries.txt b/docs/_sources/libs/libraries.txt deleted file mode 100644 index 87eae8ca..00000000 --- a/docs/_sources/libs/libraries.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. _sprout-libraries: -############################################################################### -Libraries -############################################################################### - -.. toctree:: - :hidden: - - sprout/array/index - sprout/algorithm/index - -.. _sprout-listed_by_alphabetically: -******************************************************************************* -Libraries Listed Alphabetically -******************************************************************************* - -* :doc:`algorithm <./sprout/algorithm/index>` - Standard library like generic algorithms. -* :doc:`array <./sprout/array/index>` - Standard library compliant class template for storing fixed-size sequences of objects. - -.. _sprout-listed_by_category: -******************************************************************************* -Libraries Listed by Category -******************************************************************************* - -.. _sprout-listed_by_category-containers: -Containers and Data structures -======================================= - -* :doc:`array <./sprout/array/index>` - Standard library compliant class template for storing fixed-size sequences of objects. -* :doc:`string <./sprout/string/index>` - Compile-time string of fixed-length buffer. -* :doc:`tuple <./sprout/tuple/index>` -* :doc:`optional <./sprout/optional/index>` -* :doc:`variant <./sprout/variant/index>` -* :doc:`bitset <./sprout/bitset/index>` - -.. _sprout-listed_by_category-algorithms: -Algorithms -======================================= - -* :doc:`algorithm <./sprout/algorithm/index>` - Standard library like generic algorithms. -* :doc:`numeric <./sprout/numeric/index>` -* :doc:`range_algorithm <./sprout/range/algorithm/index>` -* :doc:`range_numeric <./sprout/range/numeric/index>` -* :doc:`range_adaptor <./sprout/range/adaptor/index>` - -.. _sprout-listed_by_category-container_supports: -Container supports -======================================= - -* :doc:`sub_array <./sprout/sub_array/index>` -* :doc:`pit <./sprout/pit/index>` -* :doc:`operation <./sprout/operation/index>` -* :doc:`container <./sprout/container/index>` - -.. _sprout-listed_by_category-function_objects: -Function Objects -======================================= - -* :doc:`functional <./sprout/functional/index>` - -.. _sprout-listed_by_category-iterators: -Iterators -======================================= - -* :doc:`iterator <./sprout/iterator/index>` - -.. _sprout-listed_by_category-mathematics: -Mathematics -======================================= - -* :doc:`math_functions <./sprout/math_functions/index>` -* :doc:`random <./sprout/random/index>` -* :doc:`complex <./sprout/complex/index>` -* :doc:`rational <./sprout/rational/index>` - -.. _sprout-listed_by_category-template_metaprogramming: -Template Metaprogramming -======================================= - -* :doc:`index_tuple <./sprout/index_tuple/index>` -* :doc:`type_traits <./sprout/type_traits/index>` -* :doc:`type <./sprout/type/index>` - -.. _sprout-listed_by_category-preprocessor_metaprogramming: -Preprocessor Metaprogramming -======================================= - -* :doc:`preprocessor <./sprout/preprocessor/index>` - -.. _sprout-listed_by_category-domain_specific: -Domain specific -======================================= - -* :doc:`uuid <./sprout/uuid/index>` -* :doc:`checksum <./sprout/checksum/index>` - -.. _sprout-listed_by_category-parsing: -Parsing -======================================= - -* :doc:`weed <./sprout/weed/index>` - -.. _sprout-listed_by_category-ray_tracing: -Ray tracing -======================================= - -* :doc:`darkroom <./sprout/darkroom/index>` - -.. _sprout-listed_by_category-synthesizer: -Synthesizer -======================================= - -* :doc:`compost <./sprout/compost/index>` - -.. _sprout-listed_by_category-miscellaneous: -Miscellaneous -======================================= - -* :doc:`utility <./sprout/utility/index>` -* :doc:`bit_operation <./sprout/bit_operation/index>` - -.. _sprout-listed_by_category-c-compatible: -C-compatible -======================================= - -* :doc:`cstdlib <./sprout/cstdlib/index>` -* :doc:`cstring <./sprout/cstring/index>` -* :doc:`cwchar <./sprout/cwchar/index>` -* :doc:`cctype <./sprout/cctype/index>` -* :doc:`cinttypes <./sprout/cinttypes/index>` diff --git a/docs/index.html b/docs/index.html index 45bd5e51..a467e409 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ - Welcome to Sprout’s documentation! — Sprout 1.0 documentation + Sprout C++ Libraries — Sprout 1.0 documentation @@ -26,7 +26,7 @@ - +