Skip to content

Convert reStructuredText (.rst) files to Markdown (.md) format#6805

Closed
mhucka wants to merge 10 commits intoquantumlib:mainfrom
mhucka:mhucka-convert-rst-files
Closed

Convert reStructuredText (.rst) files to Markdown (.md) format#6805
mhucka wants to merge 10 commits intoquantumlib:mainfrom
mhucka:mhucka-convert-rst-files

Conversation

@mhucka
Copy link
Copy Markdown
Contributor

@mhucka mhucka commented Nov 19, 2024

This converts a few remaining .rst files to .md files. There is essentially no content change.

@CirqBot CirqBot added the size: L 250< lines changed <1000 label Nov 19, 2024
The script used to do the conversions is dev_tools/docs/convert_rst_to_md.sh.
We no longer have .rst files.
These are created by a previewer I'm using. We are unlikely to ever
store .html versions of files generated from .md files, so IMHO it's
okay to add these .gitignore rules. They may help other people who
similarly use previewers that produce temporary .html files.
The script used to do the conversions is dev_tools/docs/convert_rst_to_md.sh.
We no longer have .rst files.
These are created by a previewer I'm using. We are unlikely to ever
store .html versions of files generated from .md files, so IMHO it's
okay to add these .gitignore rules. They may help other people who
similarly use previewers that produce temporary .html files.
@mhucka mhucka force-pushed the mhucka-convert-rst-files branch from 9dc347b to 952550f Compare November 19, 2024 23:37
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.84%. Comparing base (2991e80) to head (261e7ed).
Report is 33 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6805      +/-   ##
==========================================
- Coverage   97.85%   97.84%   -0.02%     
==========================================
  Files        1084     1084              
  Lines       93680    93652      -28     
==========================================
- Hits        91671    91632      -39     
- Misses       2009     2020      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added status/stale Closed due to inactivity for an extended period of time and removed status/stale Closed due to inactivity for an extended period of time labels Dec 20, 2024
@mhucka
Copy link
Copy Markdown
Contributor Author

mhucka commented Jan 2, 2025

Per discussions off-line last month, we're not going to change the format of the main module README files from rst to md; we're keeping them in rst format. So, instead, I updated the rst format files in PRs #6900 and #6903. This PR is no longer relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: L 250< lines changed <1000

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants