Skip to content

Commit 5a69233

Browse files
dcolinmorgandcolinmorgan
committed
Merge branch 'master' into feat/gpu-featurization
2 parents 867874d + e74123e commit 5a69233

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+12139
-274
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,6 @@ jobs:
303303
- name: Test building docs
304304
continue-on-error: true
305305
run: |
306-
docker run --rm -v "$(pwd)/README.md:/README.md:ro" avtodev/markdown-lint:v1 README.md
306+
docker run --rm -v "$(pwd)/README.md:/workdir/README.md:ro" -v "$(pwd)/.markdownlint.yaml:/workdir/.markdownlint.yaml:ro" ghcr.io/igorshubovych/markdownlint-cli:v0.37.0 README.md
307307
308308

‎.markdownlint.yaml‎

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,267 @@
1+
# ------------------------------------------------------------------------------
2+
# Based on markdownlint/schema/.markdownlint.yml
3+
# ------------------------------------------------------------------------------
4+
5+
6+
# Example markdownlint configuration with all properties set to their default value
7+
8+
# Default state for all rules
9+
default: true
10+
11+
# Path to configuration file to extend
12+
extends: null
13+
14+
# MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md001.md
15+
MD001: true
16+
17+
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md003.md
18+
MD003:
19+
# Heading style
20+
style: "consistent"
21+
22+
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md004.md
23+
MD004:
24+
# List style
25+
style: "consistent"
26+
27+
# MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md005.md
28+
MD005: true
29+
30+
# MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md007.md
31+
MD007:
32+
# Spaces for indent
33+
indent: 2
34+
# Whether to indent the first level of the list
35+
start_indented: false
36+
# Spaces for first level indent (when start_indented is set)
37+
start_indent: 2
38+
39+
# MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md009.md
40+
MD009:
41+
# Spaces for line break
42+
br_spaces: 2
43+
# Allow spaces for empty lines in list items
44+
list_item_empty_lines: false
45+
# Include unnecessary breaks
46+
strict: false
47+
48+
# MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md010.md
49+
MD010:
50+
# Include code blocks
51+
code_blocks: true
52+
# Fenced code languages to ignore
53+
ignore_code_languages: []
54+
# Number of spaces for each hard tab
55+
spaces_per_tab: 1
56+
57+
# MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md011.md
58+
MD011: true
59+
60+
# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md012.md
61+
MD012:
62+
# Consecutive blank lines
63+
maximum: 1
64+
65+
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md013.md
66+
MD013:
67+
# Number of characters
68+
line_length: 2000
69+
# Number of characters for headings
70+
heading_line_length: 2000
71+
# Number of characters for code blocks
72+
code_block_line_length: 2000
73+
# Include code blocks
74+
code_blocks: true
75+
# Include tables
76+
tables: false
77+
# Include headings
78+
headings: true
79+
# Strict length checking
80+
strict: false
81+
# Stern length checking
82+
stern: false
83+
84+
# MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md014.md
85+
MD014: true
86+
87+
# MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md018.md
88+
MD018: true
89+
90+
# MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md019.md
91+
MD019: true
92+
93+
# MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md020.md
94+
MD020: true
95+
96+
# MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md021.md
97+
MD021: true
98+
99+
# MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md022.md
100+
MD022:
101+
# Blank lines above heading
102+
lines_above: 1
103+
# Blank lines below heading
104+
lines_below: 1
105+
106+
# MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md023.md
107+
MD023: true
108+
109+
# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md024.md
110+
MD024:
111+
# Only check sibling headings
112+
allow_different_nesting: false
113+
# Only check sibling headings
114+
siblings_only: false
115+
116+
# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md025.md
117+
MD025:
118+
# Heading level
119+
level: 1
120+
# RegExp for matching title in front matter
121+
front_matter_title: "^\\s*title\\s*[:=]"
122+
123+
# MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md026.md
124+
MD026:
125+
# Punctuation characters
126+
punctuation: ".,;:!。，；：！"
127+
128+
# MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md027.md
129+
MD027: true
130+
131+
# MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md028.md
132+
MD028: true
133+
134+
# MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md029.md
135+
MD029:
136+
# List style
137+
style: "one_or_ordered"
138+
139+
# MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md030.md
140+
MD030:
141+
# Spaces for single-line unordered list items
142+
ul_single: 1
143+
# Spaces for single-line ordered list items
144+
ol_single: 1
145+
# Spaces for multi-line unordered list items
146+
ul_multi: 1
147+
# Spaces for multi-line ordered list items
148+
ol_multi: 1
149+
150+
# MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md031.md
151+
MD031:
152+
# Include list items
153+
list_items: true
154+
155+
# MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md032.md
156+
MD032: true
157+
158+
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md033.md
159+
MD033:
160+
# Allowed elements
161+
allowed_elements: [table, tr, td, img, em,br, a]
162+
163+
# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md034.md
164+
MD034: true
165+
166+
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md035.md
167+
MD035:
168+
# Horizontal rule style
169+
style: "consistent"
170+
171+
# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md036.md
172+
MD036:
173+
# Punctuation characters
174+
punctuation: ".,;:!?。，；：！？"
175+
176+
# MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md037.md
177+
MD037: true
178+
179+
# MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md038.md
180+
MD038: true
181+
182+
# MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md039.md
183+
MD039: true
184+
185+
# MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md040.md
186+
MD040:
187+
# List of languages
188+
allowed_languages: []
189+
# Require language only
190+
language_only: false
191+
192+
# MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md041.md
193+
MD041:
194+
# Heading level
195+
level: 1
196+
# RegExp for matching title in front matter
197+
front_matter_title: "^\\s*title\\s*[:=]"
198+
199+
# MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md042.md
200+
MD042: true
201+
202+
# MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md043.md
203+
MD043: false
204+
205+
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md044.md
206+
MD044:
207+
# List of proper names
208+
names: []
209+
# Include code blocks
210+
code_blocks: true
211+
# Include HTML elements
212+
html_elements: true
213+
214+
# MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md045.md
215+
MD045: true
216+
217+
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md046.md
218+
MD046:
219+
# Block style
220+
style: "consistent"
221+
222+
# MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md047.md
223+
MD047: true
224+
225+
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md048.md
226+
MD048:
227+
# Code fence style
228+
style: "consistent"
229+
230+
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md049.md
231+
MD049:
232+
# Emphasis style
233+
style: "consistent"
234+
235+
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md050.md
236+
MD050:
237+
# Strong style
238+
style: "consistent"
239+
240+
# MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md051.md
241+
MD051: true
242+
243+
# MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md052.md
244+
MD052:
245+
# Include shortcut syntax
246+
shortcut_syntax: false
247+
248+
# MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md053.md
249+
MD053:
250+
# Ignored definitions
251+
ignored_definitions:
252+
- "//"
253+
254+
# MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.32.1/doc/md054.md
255+
MD054:
256+
# Allow autolinks
257+
autolink: true
258+
# Allow inline links and images
259+
inline: true
260+
# Allow full reference links and images
261+
full: true
262+
# Allow collapsed reference links and images
263+
collapsed: true
264+
# Allow shortcut reference links and images
265+
shortcut: true
266+
# Allow URLs as inline links
267+
url_inline: true

‎.readthedocs.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ version: 2
99
sphinx:
1010
configuration: docs/source/conf.py
1111

12+
build:
13+
os: ubuntu-22.04
14+
tools:
15+
python: "3.8"
16+
1217
# Optionally build your docs in additional formats such as PDF
1318
formats:
1419
- pdf
1520
- htmlzip
1621
- epub
1722

1823
python:
19-
version: "3.8"
2024
install:
2125
- method: pip
2226
path: .

0 commit comments

Comments
 (0)