Convert the main readme into an rst file to correctly render the device support table in GitHub #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
nfelt14
commented
Sep 26, 2023
•
nfelt14
commented
- Converted main readme to rst
- Updated license file with full license text
- Added sphinx extension to fix relative links to markdown files from rst files
…ith a name that won't collide with .env files. Signed-off-by: Nicholas Felt <nicholas.felt@tektronix.com>
… render properly on GitHub. Signed-off-by: Nicholas Felt <nicholas.felt@tektronix.com>
…nes in the headers.
…o use rst syntax.
…rkdown and the full Apache 2.0 license text.
…eading. Also removed the old markdown readme.
…mermaid diagrams from rst files.
… device support table have the device type in the first column. The new method works for tables generated from rst, which have an extra whitespace in the th element.
nfelt14
force-pushed
the
nfelt14/convert-readme-to-rst
branch
from
fb492a3 to
f31bd94
Compare
Codecov Report
@@ Coverage Diff @@
## main #12 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 168 168
Lines 3745 3745
Branches 672 672
=========================================
Hits 3745 3745 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
…directives that are not allowed by pypi.org.
|
The pyright failures should be resolved with the next release of pyright tomorrow. |
michaelwagoner
approved these changes
Sep 28, 2023
nfelt14
added a commit
that referenced
this pull request
Sep 28, 2023
…ce support table in GitHub (#12) * ci: Update contributor setup script to create a virtual environment with a name that won't collide with .env files. * docs: Started converting the main readme to rst in order to get it to render properly on GitHub. * docs: Updated the device support table in rst to correctly have newlines in the headers. * docs: Update the headers for the device support table with better wording. * docs: Updated internal links on the readme. Also updated the badges to use rst syntax. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Use external links for simplicity. * docs: Use external links for simplicity. * docs: Update license text so that GitHub can auto-detect the license type. * docs: Fix table of contents. * docs: Converted the readme to rst. Updated the license document to markdown and the full Apache 2.0 license text. * docs: Converted the badge section into a table of badges for easier reading. Also removed the old markdown readme. * docs: Remove extra header from license. * docs: Update readme badges with auto-wrapping tables. * docs: Add advanced architecture.rst file to test github's rst mermaid rendering. * docs: Remove rst version of architecture file, GitHub doesn't render mermaid diagrams from rst files. * docs: Updated custom css file to more easily detect which rows in the device support table have the device type in the first column. The new method works for tables generated from rst, which have an extra whitespace in the th element. * docs: Updated the custom css for the device support table to not use directives that are not allowed by pypi.org. * ci: Update tox environment to run a build and twine check. * docs: Add code to enable doc tests to run by disabling an extension based on command line inputs. * test: add xfail marker to linkcheck test since the package is not on pypi.org * ci: Always upload coverage to codecov to get accurate data on PR comments.
michaelwagoner
pushed a commit
to michaelwagoner/tm_devices
that referenced
this pull request
Sep 29, 2023
…ce support table in GitHub (tektronix#12) * ci: Update contributor setup script to create a virtual environment with a name that won't collide with .env files. * docs: Started converting the main readme to rst in order to get it to render properly on GitHub. * docs: Updated the device support table in rst to correctly have newlines in the headers. * docs: Update the headers for the device support table with better wording. * docs: Updated internal links on the readme. Also updated the badges to use rst syntax. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Use external links for simplicity. * docs: Use external links for simplicity. * docs: Update license text so that GitHub can auto-detect the license type. * docs: Fix table of contents. * docs: Converted the readme to rst. Updated the license document to markdown and the full Apache 2.0 license text. * docs: Converted the badge section into a table of badges for easier reading. Also removed the old markdown readme. * docs: Remove extra header from license. * docs: Update readme badges with auto-wrapping tables. * docs: Add advanced architecture.rst file to test github's rst mermaid rendering. * docs: Remove rst version of architecture file, GitHub doesn't render mermaid diagrams from rst files. * docs: Updated custom css file to more easily detect which rows in the device support table have the device type in the first column. The new method works for tables generated from rst, which have an extra whitespace in the th element. * docs: Updated the custom css for the device support table to not use directives that are not allowed by pypi.org. * ci: Update tox environment to run a build and twine check. * docs: Add code to enable doc tests to run by disabling an extension based on command line inputs. * test: add xfail marker to linkcheck test since the package is not on pypi.org * ci: Always upload coverage to codecov to get accurate data on PR comments. Signed-off-by: Mike Wagoner <michael.wagoner@tektronix.com>
v12ganesh
pushed a commit
to v12ganesh/tm_devices
that referenced
this pull request
Mar 28, 2024
…ce support table in GitHub (tektronix#12) * ci: Update contributor setup script to create a virtual environment with a name that won't collide with .env files. * docs: Started converting the main readme to rst in order to get it to render properly on GitHub. * docs: Updated the device support table in rst to correctly have newlines in the headers. * docs: Update the headers for the device support table with better wording. * docs: Updated internal links on the readme. Also updated the badges to use rst syntax. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test out standard rst link. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Test relative links in GitHub. * docs: Use external links for simplicity. * docs: Use external links for simplicity. * docs: Update license text so that GitHub can auto-detect the license type. * docs: Fix table of contents. * docs: Converted the readme to rst. Updated the license document to markdown and the full Apache 2.0 license text. * docs: Converted the badge section into a table of badges for easier reading. Also removed the old markdown readme. * docs: Remove extra header from license. * docs: Update readme badges with auto-wrapping tables. * docs: Add advanced architecture.rst file to test github's rst mermaid rendering. * docs: Remove rst version of architecture file, GitHub doesn't render mermaid diagrams from rst files. * docs: Updated custom css file to more easily detect which rows in the device support table have the device type in the first column. The new method works for tables generated from rst, which have an extra whitespace in the th element. * docs: Updated the custom css for the device support table to not use directives that are not allowed by pypi.org. * ci: Update tox environment to run a build and twine check. * docs: Add code to enable doc tests to run by disabling an extension based on command line inputs. * test: add xfail marker to linkcheck test since the package is not on pypi.org * ci: Always upload coverage to codecov to get accurate data on PR comments. Signed-off-by: v12ganesh ganesh.v@tektronix.com
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.