|
113 | 113 | scv_overflow = ("-D", "html_show_sphinx=False") |
114 | 114 |
|
115 | 115 | # Choosing to not generate documentation on any branch and rely solely on |
116 | | -# Github tags. Branches are whitelisted with option 'scv_whitelist_branches'. |
| 116 | +# Github tags. Branches are a_listed with option 'scv_a_list_branches'. |
117 | 117 | # In other words, filter out any branches that don't match the pattern. |
118 | | -scv_whitelist_branches = (' ',) |
| 118 | +scv_a_list_branches = (' ',) |
119 | 119 |
|
120 | | -# Since all branches are whitelisted, a 'root_ref' must be specified to avoid |
| 120 | +# Since all branches are a_listed, a 'root_ref' must be specified to avoid |
121 | 121 | # the error: "Root ref master not found in: v1.0.0 v1.1.0-beta1". The simplest |
122 | 122 | # solution is to provide a known tagged branch to serve as the root_ref such |
123 | 123 | # as 'v1.0.0'. |
|
126 | 126 | # scv_root_ref = 'v1.0.0' |
127 | 127 |
|
128 | 128 | # Override root-ref to be the most recent committed tag. If no tags have docs |
129 | | -# then this option is ignored and --root-ref is used. Since we whitelist the |
| 129 | +# then this option is ignored and --root-ref is used. Since we a_list the |
130 | 130 | # master branch, we need to set a "root_ref" to avoid error |
131 | 131 | # "Root ref master not found in: v1.0.0 v1.1.0-beta1", See also 'scv_root_ref'. |
132 | 132 | # UPDATE: Able to avoid 'root_ref' by setting property 'scv_greatest_tag= True' |
|
135 | 135 |
|
136 | 136 | # Override root-ref to be the tag with the highest version number. If no tags |
137 | 137 | # have docs then this option is ignored and --root-ref is used. Since we |
138 | | -# whitelist the master branch, we need to set a root_ref. |
| 138 | +# a_list the master branch, we need to set a root_ref. |
139 | 139 | # See also 'scv_root_ref |
140 | 140 | scv_greatest_tag = True |
141 | 141 |
|
142 | 142 | # White list which Git tags documentation will be generated and linked into the |
143 | 143 | # version selection box. This is currently a manual selection, until more |
144 | 144 | # versions are released, there are no regular expressions used. |
145 | | -scv_whitelist_tags = ('v1.0.1', 'v1.1.0') |
| 145 | +scv_a_list_tags = ('v1.0.1', 'v1.1.0') |
146 | 146 |
|
147 | 147 | # Sort versions by one or more values. Valid values are semver, alpha, and time. |
148 | 148 | # Semantic is referred to as 'semver', this would ensure our latest VRM is |
|
0 commit comments