Skip to content

Commit 47c97fb

Browse files
authored
DRIVERS-2789 Trim RST files to Stubs (#1566)
* DRIVERS-2789 Trim RST files to Stubs * remove sphinx build check
1 parent b746fcc commit 47c97fb

File tree

26 files changed

+3
-26895
lines changed

26 files changed

+3
-26895
lines changed

.github/workflows/lint.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,3 @@ jobs:
2727
echo " pre-commit run"
2828
echo "or after-the-fact on already committed files with"
2929
echo " pre-commit run --all-files --hook-stage manual"
30-
31-
sphinx-build:
32-
runs-on: ubuntu-latest
33-
timeout-minutes: 5
34-
35-
steps:
36-
- uses: actions/checkout@v4
37-
- uses: actions/setup-python@v4
38-
- run: pip install sphinx
39-
- run: cd source && sphinx-build -W -b text . docs_build index.rst

scripts/migrate_to_md.py

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,13 @@
2828
.. note::
2929
This specification has been converted to Markdown and renamed to
3030
`{0} <{0}>`_.
31-
32-
Use the link above to access the latest version of the specification as the
33-
current reStructuredText file will no longer be updated.
34-
3531
"""
3632

37-
# Update the RST file with a pointer to the MD file.
33+
# Update the RST file with a stub pointer to the MD file.
3834
if not path.name == 'README.rst':
39-
new_lines = lines.copy()
40-
new_lines.insert(0, TEMPLATE.format(os.path.basename(md_file)) )
35+
new_body = TEMPLATE.format(os.path.basename(md_file))
4136
with path.open('w') as fid:
42-
fid.write(''.join(new_lines))
37+
fid.write(''.join(new_body))
4338

4439
# Pre-process the file.
4540
for (i, line) in enumerate(lines):

0 commit comments

Comments
 (0)