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

Fix documentation build configuration file for Windows #3148

Merged
merged 2 commits into from
Jul 25, 2018

Conversation

Harmon758
Copy link
Member

What does this change do?

Fixes documentation builds for Windows

Are there changes in behavior for the user?

No
Python <2.6 support is dropped for building the documentation
Not sure why codecs.open was used, but Python 2.6+ support is maintained with io.open

Related issue number

Fixes #3147

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@codecov-io
Copy link

Codecov Report

Merging #3148 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3148   +/-   ##
=======================================
  Coverage   98.09%   98.09%           
=======================================
  Files          43       43           
  Lines        7833     7833           
  Branches     1351     1351           
=======================================
  Hits         7684     7684           
  Misses         57       57           
  Partials       92       92

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6b9b7b...8930b5e. Read the comment docs.

@asvetlov
Copy link
Member

I don't follow why do you need to build docs on Python 2.6?
aiohttp is intended to build by Python 3 only

@Harmon758
Copy link
Member Author

I don't need to build them on Python 2, but I don't see any other reason codecs.open would be used instead of just open.
So that support for Python 2.6+ is maintained with io.open instead of dropped here, while still resolving the issue.

Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

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

I don't care but if the change helps you -- why not?

@asvetlov asvetlov merged commit 5e7e457 into aio-libs:master Jul 25, 2018
@Harmon758 Harmon758 deleted the fix-windows-conf.py branch July 25, 2018 21:19
@lock
Copy link

lock bot commented Oct 28, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a [new issue] for related bugs.
If you feel like there's important points made in this discussion, please include those exceprts into that [new issue].
[new issue]: https://github.com/aio-libs/aiohttp/issues/new

@lock lock bot added the outdated label Oct 28, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 28, 2019
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bot:chronographer:provided There is a change note present in this PR outdated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Windows documentation build failure
3 participants