xstd-bits/mkdocs.yml at main · rhalbersma/xstd-bits · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
#          Copyright Rein Halbersma 2014-2026.
# 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)

# The documentation site, built by the pages workflow from the README and doc/. tools/mkdocs_hooks.py serves the
# README as the index and points each relative link at its page, or at its file on GitHub where the site has none.

site_name: xstd-bits
site_description: Bitwise extensions to the C++ Standard Library
site_url: https://rhalbersma.github.io/xstd-bits/
repo_url: https://github.com/rhalbersma/xstd-bits
repo_name: rhalbersma/xstd-bits
edit_uri: ""
copyright: Copyright Rein Halbersma 2014-2026, under the Boost Software License, Version 1.0

docs_dir: doc
exclude_docs: |
  audit/
  mutation.md

hooks:
  - tools/mkdocs_hooks.py

nav:
  - Overview: index.md
  - Reference:
    - reference/index.md
    - bit.hpp:
      - reference/bit/index.md
      - bit_convert.hpp: reference/bit/bit_convert.md
      - shl.hpp: reference/bit/shl.md
    - bit_algorithm.hpp:
      - reference/bit_algorithm/index.md
      - bit_all_of.hpp: reference/bit_algorithm/bit_all_of.md
      - bit_any_of.hpp: /xstd-bits/reference/bit_algorithm/bit_all_of/
      - bit_copy.hpp: reference/bit_algorithm/bit_copy.md
      - bit_copy_backward.hpp: /xstd-bits/reference/bit_algorithm/bit_copy/
      - bit_count.hpp: reference/bit_algorithm/bit_count.md
      - bit_disjoint.hpp: /xstd-bits/reference/bit_algorithm/bit_includes/
      - bit_equal.hpp: reference/bit_algorithm/bit_equal.md
      - bit_fill.hpp: reference/bit_algorithm/bit_fill.md
      - bit_find.hpp: reference/bit_algorithm/bit_find.md
      - bit_find_last.hpp: /xstd-bits/reference/bit_algorithm/bit_find/
      - bit_for_each.hpp: reference/bit_algorithm/bit_for_each.md
      - bit_includes.hpp: reference/bit_algorithm/bit_includes.md
      - bit_intersects.hpp: /xstd-bits/reference/bit_algorithm/bit_includes/
      - bit_is_partitioned.hpp: /xstd-bits/reference/bit_algorithm/bit_is_sorted/
      - bit_is_sorted.hpp: reference/bit_algorithm/bit_is_sorted.md
      - bit_lexicographical_compare_three_way.hpp: reference/bit_algorithm/bit_lexicographical_compare_three_way.md
      - bit_mismatch.hpp: reference/bit_algorithm/bit_mismatch.md
      - bit_move.hpp: /xstd-bits/reference/bit_algorithm/bit_copy/
      - bit_none_of.hpp: /xstd-bits/reference/bit_algorithm/bit_all_of/
      - bit_partition.hpp: reference/bit_algorithm/bit_partition.md
      - bit_partition_point.hpp: reference/bit_algorithm/bit_partition_point.md
      - bit_reverse.hpp: reference/bit_algorithm/bit_reverse.md
      - bit_reverse_copy.hpp: reference/bit_algorithm/bit_reverse_copy.md
      - bit_rotate.hpp: reference/bit_algorithm/bit_rotate.md
      - bit_rotate_copy.hpp: reference/bit_algorithm/bit_rotate_copy.md
      - bit_set_difference.hpp: /xstd-bits/reference/bit_algorithm/bit_set_union/
      - bit_set_intersection.hpp: /xstd-bits/reference/bit_algorithm/bit_set_union/
      - bit_set_symmetric_difference.hpp: /xstd-bits/reference/bit_algorithm/bit_set_union/
      - bit_set_union.hpp: reference/bit_algorithm/bit_set_union.md
      - bit_shift_left.hpp: reference/bit_algorithm/bit_shift_left.md
      - bit_shift_right.hpp: /xstd-bits/reference/bit_algorithm/bit_shift_left/
      - bit_sort.hpp: reference/bit_algorithm/bit_sort.md
      - bit_swap_ranges.hpp: reference/bit_algorithm/bit_swap_ranges.md
      - bit_transform.hpp: reference/bit_algorithm/bit_transform.md
    - bit_array.hpp:
      - reference/bit_array/index.md
      - bit_array.hpp: reference/bit_array/bit_array.md
      - container_hash.hpp: /xstd-bits/reference/bit_array/hash/
      - hash.hpp: reference/bit_array/hash.md
      - to_array.hpp: reference/bit_array/to_array.md
      - tuple_element.hpp: reference/bit_array/tuple_element.md
    - bit_concepts.hpp:
      - reference/bit_concepts/index.md
      - bit_blocks.hpp: reference/bit_concepts/bit_blocks.md
      - bit_constructible_from.hpp: reference/bit_concepts/bit_constructible_from.md
      - bit_convertible_to.hpp: reference/bit_concepts/bit_convertible_to.md
      - bit_index_mapping.hpp: reference/bit_concepts/bit_index_mapping.md
      - bit_mask_mapping.hpp: reference/bit_concepts/bit_mask_mapping.md
      - bit_storage.hpp: reference/bit_concepts/bit_storage.md
      - sized_bit_index_mapping.hpp: reference/bit_concepts/sized_bit_index_mapping.md
    - bit_functional.hpp:
      - reference/bit_functional/index.md
      - bit_compare_three_way.hpp: reference/bit_functional/bit_compare_three_way.md
      - bit_digest.hpp: reference/bit_functional/bit_digest.md
      - bit_equal_to.hpp: reference/bit_functional/bit_equal_to.md
      - bit_greater.hpp: reference/bit_functional/bit_greater.md
      - bit_greater_equal.hpp: /xstd-bits/reference/bit_functional/bit_greater/
      - bit_hash.hpp: reference/bit_functional/bit_hash.md
      - bit_less.hpp: /xstd-bits/reference/bit_functional/bit_greater/
      - bit_less_equal.hpp: /xstd-bits/reference/bit_functional/bit_greater/
      - bit_not_equal_to.hpp: /xstd-bits/reference/bit_functional/bit_equal_to/
    - bit_inplace_vector.hpp:
      - reference/bit_inplace_vector/index.md
      - bit_inplace_vector.hpp: reference/bit_inplace_vector/bit_inplace_vector.md
      - container_hash.hpp: /xstd-bits/reference/bit_inplace_vector/hash/
      - erase_if.hpp: reference/bit_inplace_vector/erase_if.md
      - hash.hpp: reference/bit_inplace_vector/hash.md
    - bit_iterator.hpp:
      - reference/bit_iterator/index.md
      - bit_advance.hpp: reference/bit_iterator/bit_advance.md
      - bit_distance.hpp: reference/bit_iterator/bit_distance.md
      - bit_next.hpp: reference/bit_iterator/bit_next.md
      - bit_prev.hpp: /xstd-bits/reference/bit_iterator/bit_next/
    - bit_ranges.hpp:
      - reference/bit_ranges/index.md
      - from_blocks.hpp: reference/bit_ranges/from_blocks.md
    - bit_set.hpp:
      - reference/bit_set/index.md
      - bit_enum_set.hpp: reference/bit_set/bit_enum_set.md
      - bit_fixed_set.hpp: reference/bit_set/bit_fixed_set.md
      - bit_flag_mapping.hpp: reference/bit_set/bit_flag_mapping.md
      - bit_flag_set.hpp: reference/bit_set/bit_flag_set.md
      - bit_inplace_set.hpp: reference/bit_set/bit_inplace_set.md
      - bit_key_mapping.hpp: reference/bit_set/bit_key_mapping.md
      - bit_set.hpp: reference/bit_set/bit_set.md
      - bit_set_view.hpp: reference/bit_set/bit_set_view.md
      - container_hash.hpp: /xstd-bits/reference/bit_set/hash/
      - erase_if.hpp: reference/bit_set/erase_if.md
      - hash.hpp: reference/bit_set/hash.md
      - indeterminate.hpp: reference/bit_set/indeterminate.md
    - bit_span.hpp:
      - reference/bit_span/index.md
      - bit_span.hpp: reference/bit_span/bit_span.md
      - bit_subspan.hpp: reference/bit_span/bit_subspan.md
    - bit_type_traits.hpp:
      - reference/bit_type_traits/index.md
      - bit_align.hpp: reference/bit_type_traits/bit_align.md
      - bit_blocks_extent.hpp: reference/bit_type_traits/bit_blocks_extent.md
      - bit_fast.hpp: reference/bit_type_traits/bit_fast.md
      - bit_least.hpp: reference/bit_type_traits/bit_least.md
      - bit_rebind.hpp: reference/bit_type_traits/bit_rebind.md
      - bit_resize.hpp: reference/bit_type_traits/bit_resize.md
      - bit_storage_rebind.hpp: reference/bit_type_traits/bit_storage_rebind.md
      - bit_underlying.hpp: reference/bit_type_traits/bit_underlying.md
    - bit_valarray.hpp:
      - reference/bit_valarray/index.md
      - bit_fixed_valarray.hpp: reference/bit_valarray/bit_fixed_valarray.md
      - bit_gslice.hpp: reference/bit_valarray/bit_gslice.md
      - bit_gslice_array.hpp: /xstd-bits/reference/bit_valarray/bit_slice_array/
      - bit_indirect_array.hpp: /xstd-bits/reference/bit_valarray/bit_slice_array/
      - bit_inplace_valarray.hpp: reference/bit_valarray/bit_inplace_valarray.md
      - bit_mask_array.hpp: /xstd-bits/reference/bit_valarray/bit_slice_array/
      - bit_slice.hpp: reference/bit_valarray/bit_slice.md
      - bit_slice_array.hpp: reference/bit_valarray/bit_slice_array.md
      - bit_valarray.hpp: reference/bit_valarray/bit_valarray.md
    - bit_vector.hpp:
      - reference/bit_vector/index.md
      - bit_vector.hpp: reference/bit_vector/bit_vector.md
      - container_hash.hpp: /xstd-bits/reference/bit_vector/hash/
      - erase_if.hpp: reference/bit_vector/erase_if.md
      - hash.hpp: reference/bit_vector/hash.md
    - ext/boost.hpp:
      - reference/ext_boost/index.md
      - ext/boost/bit_small_set.hpp: reference/ext_boost/bit_small_set.md
      - ext/boost/bit_small_valarray.hpp: reference/ext_boost/bit_small_valarray.md
      - ext/boost/bit_small_vector.hpp: reference/ext_boost/bit_small_vector.md
    - ext/boost/dynamic_bitset.hpp: reference/ext_boost_dynamic_bitset/index.md
  - Design: design.md
  - Migration: migration.md

theme:
  name: material
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.path
    - navigation.top
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# The reference index's relation table keeps each entity name on one line.
extra_css:
  - stylesheets/reference.css

markdown_extensions:
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - md_in_html

validation:
  links:
    anchors: warn
    unrecognized_links: warn