Skip to content

convert esp32s2 port readme to rst #3945

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.

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

Merged
merged 2 commits into from
Jan 7, 2021
Merged

convert esp32s2 port readme to rst #3945

merged 2 commits into from
Jan 7, 2021

Conversation

2bndy5
Copy link

@2bndy5 2bndy5 commented Jan 6, 2021

closes #3938

I chose to convert the whole file to rst syntax so that the table will render properly on github & readthedocs.
Sphinx is configured to expect either format (no need to explicitly mention the file extension).

I also verified changes render properly.

@2bndy5
Copy link
Author

2bndy5 commented Jan 7, 2021

This build CI workflow takes forever. I wish there was an easy way to separate the building docs changes from the building firmware changes. My first guess would be a separate workflow for building the firmware that ignores changes to *.rst & *.md files (& the docs folder) using

on:
  push:
    paths:
      - "**/*"
      - "!**/*.md"
      - "!**/*.rst"
      - "!docs/**"
  pull_request:
    paths:
      - "**/*"
      - "!**/*.md"
      - "!**/*.rst"
      - "!docs/**"
  release:
    types: [published]
  check_suite:
    types: [rerequested]

I also find it a little weird to upload all non-released doc build artifacts. That could simply be avoided by adding

if: ${{ github.event_name == 'release'}}

for the steps following the "Test Documentation Build (<builder>)" steps.

@tannewt
Copy link
Member

tannewt commented Jan 7, 2021

This build CI workflow takes forever. I wish there was an easy way to separate the building docs changes from the building firmware changes. My first guess would be a separate workflow for building the firmware that ignores changes to *.rst & *.md files (& the docs folder) using

We could definitely do this for pure doc changes. Many C files have docs in them as well so we'll still need the full set of tests for those changes.

I also find it a little weird to upload all non-released doc build artifacts.

We definitely want this. It allows folks to test PR artifacts without need to clone the branch locally and build.

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@tannewt tannewt merged commit 55c8075 into adafruit:main Jan 7, 2021
@2bndy5 2bndy5 deleted the fix-table-in-a-readme branch January 7, 2021 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix rendering a table in esp32s2 readme.md on readthedocs
2 participants