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

Adapt to upcoming Sphinx 2.0 #411

Merged
merged 7 commits into from
Apr 21, 2019
Merged

Conversation

jakobandersen
Copy link
Collaborator

Initial steps to adapt to the upcoming version of Sphinx (2.0).

@svenevs
Copy link

svenevs commented Jan 23, 2019

Thank you @jakobanderson this is really helpful! I was under the impression that we needed to switch to pytest in order for the tests to run / user the sphinx fixtures. But it appears this is not the case.

Does this supersede #410?

@jakobandersen
Copy link
Collaborator Author

I think the testing between the projects are completely independent, though from my limited understanding of Python tooling it may still be a good idea to switch to pytest at some point (the Sphinx PR for switching: sphinx-doc/sphinx#3302),

I should probably have described the PR dependencies and their context:

  1. If Adapt to Sphinx 1.8 #410 looks ok for you, it can be merged immediately so Breathe works completely with a supported Sphinx version.
  2. (optionally) I have some code simplifications that shifts functionality to using the core Sphinx support, and I think also fixes some bugs. They can be applied after Adapt to Sphinx 1.8 #410.
  3. The upcoming Sphinx 1.8.4 probably doesn't require any updates, except for the Travis script.
  4. After Sphinx 2.0 has been released (see 2.0.0 release plan sphinx-doc/sphinx#5950) then this PR can be applied. It includes Adapt to Sphinx 1.8 #410, so in a few months it will superseede it.
  5. (optionally) More code simplifications (and bug fixes?).

@vermeeren vermeeren added test Unit tests, acceptance tests code Source code labels Jan 23, 2019
@vermeeren
Copy link
Collaborator

Thanks a lot for all submitting all these patches. I have been rather busy for a while so my responses to Breathe-related things have been slow. PR #410 seems ok to me, so I'll merge it now.

Indeed long term the plan for an eventual Breathe 5 is to rewrite and/or refactor major parts of the sometimes overly complex logic and let Sphinx itself handle things cleanly. As you said I am sure this will fix several open bugs and quirks. Thanks again!

@jakobandersen
Copy link
Collaborator Author

If you trigger a rebuild in Travis it should(TM) succeed now that Sphinx 2.0 has been released.

@meeludwig
Copy link

Hi michaeljones,
maybe I have found a rather deep & simple isse, rather breathe and not sphinx or doxygen.
sphinx-doc/sphinx#6146
Thanks , michael

@jakobandersen
Copy link
Collaborator Author

Doh, nevermind, 2.0 is close to be released, but it will take a few more weeks.

@t-b t-b mentioned this pull request Apr 1, 2019
@t-b
Copy link
Contributor

t-b commented Apr 2, 2019

@jakobandersen Can you push to trigger a build?

@jakobandersen
Copy link
Collaborator Author

Now I think the PR should be ready to merge :-)

@vermeeren
Copy link
Collaborator

Looks good to me. Just to make sure: merge this and release as v4.13.0?

@vermeeren vermeeren self-assigned this Apr 2, 2019
@amirmasoudabdol
Copy link

I'm wondering if there is still an issue with this PR? I'm using it for a while and it works fine, it'd be nice to merge it and have a new version :-) If there is an issue, I'm happy to help btw.

@Milerius
Copy link

can we merge this ?

@vermeeren vermeeren merged commit e788016 into breathe-doc:master Apr 21, 2019
vermeeren added a commit that referenced this pull request Apr 21, 2019
@vermeeren
Copy link
Collaborator

I have released v4.13.0 containing this fix, all should be good now.

@Milerius
Copy link

@melvinvermeeren is it ready in pip ?

@vermeeren
Copy link
Collaborator

@Milerius Should be up now, the upload was running at the time you posted.

@Milerius
Copy link

@melvinvermeeren Thank's a lot i made the upgrade

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code Source code test Unit tests, acceptance tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants