Skip to content

Update README in docs/#5472

Merged
jepler merged 1 commit intoadafruit:mainfrom
fraziern:fraziern-docs-readme
Oct 16, 2021
Merged

Update README in docs/#5472
jepler merged 1 commit intoadafruit:mainfrom
fraziern:fraziern-docs-readme

Conversation

@fraziern
Copy link
Copy Markdown

Update README in docs/ to reflect changes in package requirements. recommonmark is no longer used and has been replaced with myst-parser. Additionally there are other packages required, like isort and black. This change to the documentation covers all that and is future-proof for other changes to requirements that may happen.

Copy link
Copy Markdown
Collaborator

@microdev1 microdev1 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @fraziern. One suggestion, I think the circuitpython/requirements-doc.txt is a more complete dependency file for docs, it is also used in CI.

Comment thread docs/README.md Outdated
Comment thread docs/README.md Outdated
Update README in docs/ to reflect changes in package requirements
@fraziern fraziern force-pushed the fraziern-docs-readme branch from 224539b to 645d513 Compare October 16, 2021 21:48
@fraziern
Copy link
Copy Markdown
Author

Commit has been updated to incorporate changes. Thanks @microdev1

@fraziern
Copy link
Copy Markdown
Author

Also, if this PR is accepted, would you mind adding the hacktoberfest-accepted label to it please? Thanks!

Copy link
Copy Markdown

@jepler jepler 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!

@jepler jepler requested a review from microdev1 October 16, 2021 22:21
@jepler jepler dismissed microdev1’s stale review October 16, 2021 22:21

changes addressed

@jepler jepler merged commit 2736b46 into adafruit:main Oct 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants