Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DRIVERS-2789 Trim RST files to Stubs #1566

Merged
merged 3 commits into from
Apr 22, 2024
Merged

DRIVERS-2789 Trim RST files to Stubs #1566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbb2183
DRIVERS-2789 Trim RST files to Stubs
blink1073 Apr 22, 2024
cd8f412
remove sphinx build check
blink1073 Apr 22, 2024
157d50d
Merge branch 'master' into DRIVERS-2789-rst-stubs
blink1073 Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,3 @@ jobs:
echo " pre-commit run"
echo "or after-the-fact on already committed files with"
echo " pre-commit run --all-files --hook-stage manual"

sphinx-build:
runs-on: ubuntu-latest
timeout-minutes: 5

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
- run: pip install sphinx
- run: cd source && sphinx-build -W -b text . docs_build index.rst
11 changes: 3 additions & 8 deletions scripts/migrate_to_md.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,13 @@
.. note::
This specification has been converted to Markdown and renamed to
`{0} <{0}>`_.

Use the link above to access the latest version of the specification as the
current reStructuredText file will no longer be updated.

"""

# Update the RST file with a pointer to the MD file.
# Update the RST file with a stub pointer to the MD file.
if not path.name == 'README.rst':
new_lines = lines.copy()
new_lines.insert(0, TEMPLATE.format(os.path.basename(md_file)) )
new_body = TEMPLATE.format(os.path.basename(md_file))
with path.open('w') as fid:
fid.write(''.join(new_lines))
fid.write(''.join(new_body))

# Pre-process the file.
for (i, line) in enumerate(lines):
Expand Down
Loading
Loading