Skip to content
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

Jump to bottom

Fix and test docs on Windows #2262

Merged
merged 1 commit into from May 27, 2021
Merged

Fix and test docs on Windows #2262

merged 1 commit into from May 27, 2021

Conversation

ichard26
Copy link
Collaborator

There's some weird interaction between Click and
sphinxcontrib-programoutput on Windows that leads to an encoding error
during the printing of black-primer's help text.

Also symlinks aren't well supported on Windows so let's just use
includes which actually work because we now use MyST :D

@ichard26
Fix and test docs on Windows
2d02f29 
There's some weird interaction between Click and
sphinxcontrib-programoutput on Windows that leads to an encoding error
during the printing of black-primer's help text.

Also symlinks aren't well supported on Windows so let's just use
includes which actually work because we now use MyST :D
@ichard26 ichard26 added T: documentation Improvements to the docs (e.g. new topic, correction, etc) C: maintenance Related to project maintenance, e.g. CI, testing, policy changes, releases labels May 26, 2021
HassanAbouelela
HassanAbouelela approved these changes May 27, 2021
View reviewed changes
Copy link
Contributor

@HassanAbouelela HassanAbouelela left a comment

Choose a reason for hiding this comment

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

Tested locally, and everything works as expected.

Adding windows to the CI is an appreciated touch.

cooperlees
cooperlees approved these changes May 27, 2021
View reviewed changes
Copy link
Collaborator

@cooperlees cooperlees left a comment

Choose a reason for hiding this comment

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

LGTM - Thanks doc guru.

.github/workflows/doc.yml
steps:
- uses: actions/checkout@v2

- name: Set up Python 3.9
- name: Set up latest Python
Copy link
Collaborator

Choose a reason for hiding this comment

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

🥰

@cooperlees cooperlees merged commit 6613e76 into main May 27, 2021
@cooperlees cooperlees deleted the docs-on-windows branch May 27, 2021 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cooperlees cooperlees cooperlees approved these changes

@HassanAbouelela HassanAbouelela HassanAbouelela approved these changes

Assignees
No one assigned
Labels
C: maintenance Related to project maintenance, e.g. CI, testing, policy changes, releases T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@ichard26 @cooperlees @HassanAbouelela