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

Test and work properly on sphinx < 1.7 #16

Merged
merged 5 commits into from Aug 6, 2018

Conversation

njsmith
Copy link
Member

@njsmith njsmith commented Aug 6, 2018

Also adds testing on 3.7

Fixes gh-15

@codecov
Copy link

codecov bot commented Aug 6, 2018

Codecov Report

Merging #16 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #16   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           3      3           
  Lines         264    267    +3     
  Branches       42     42           
=====================================
+ Hits          264    267    +3
Impacted Files Coverage Δ
sphinxcontrib_trio/__init__.py 100% <100%> (ø) ⬆️

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 3b7d19d...8e39125. Read the comment docs.

Sraw added 2 commits August 6, 2018 10:46
Add a compatible way in `sphinx==1.6.x`
Update description.
@Sraw
Copy link

Sraw commented Aug 6, 2018

I guess it works fine now :)

@njsmith
Copy link
Member Author

njsmith commented Aug 6, 2018

@Sraw oh awesome!

....okay now I'm confused though. Do you know why my first version passed the tests? I forgot to disable the test you added to make sure that the ordering worked, so it should have failed, I think...

@Sraw
Copy link

Sraw commented Aug 6, 2018

I am confused too. Let me have a look.

@Sraw
Copy link

Sraw commented Aug 6, 2018

Funny, it works out of the box lol. Seems my modification is redundant.
I've searched a lot and cannot fully understand why. Guess sphinx==1.6.7 cannot really distinguish normal function and async funtion.

I will dive in further when I am free.

@njsmith
Copy link
Member Author

njsmith commented Aug 6, 2018

Huh. Yeah, it is possible that the original bug only affected sphinx 1.7 and we never noticed until now, I could believe that.

@Sraw
Copy link

Sraw commented Aug 6, 2018

Yep, as our test never covers sphinx~=1.6.0 at all before.
Now it is fine. I guess the modification can be removed.

Sraw and others added 2 commits August 6, 2018 14:40
@njsmith
Copy link
Member Author

njsmith commented Aug 6, 2018

OK that was a lot more confusing than I expected but I think we've got it nailed down now! I was impressed by how quickly you figured out the AttrDocVisitor trick, even if it turned out not to be needed after all :-)

@njsmith njsmith merged commit 469b11d into python-trio:master Aug 6, 2018
@njsmith njsmith deleted the untangle-sphinx-requirement branch August 6, 2018 08:58
@Sraw
Copy link

Sraw commented Aug 6, 2018

Congratulation :-)

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.

None yet

2 participants