Added a step that renders the readme #77
Merged
Conversation
This file contains hidden or 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
Author
|
Ah, I think I did this in the wrong spot |
Collaborator
Author
|
Haven't tested. Doing that now |
Collaborator
Author
|
Tested here and it works great: |
Contributor
|
@dherrada Let's give @tannewt @kattni and @sommersoft a chance to chime in before merging |
tannewt
reviewed
Jul 2, 2020
| - name: Build docs | ||
| working-directory: docs | ||
| run: sphinx-build -E -W -b html . _build/html | ||
| - name: Build README |
Member
There was a problem hiding this comment.
I'd call this Build python package since it'll fail if the setup.py steps fail. Otherwise, this looks good to me.
Collaborator
Author
There was a problem hiding this comment.
Ok, I've renamed it. Thanks for taking a look at this
tannewt
approved these changes
Jul 3, 2020
Member
tannewt
left a comment
tannewt
left a comment
There was a problem hiding this comment.
Thank you! Always good to automatically test things.
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.
#61
The current issue is that the only time you'll know the README isn't rendering now is after the library has been released to PyPI, which isn't really ideal, since if it isn't rendering right, it doesn't really tell you where the issue is and you'll have to re-release it.