Skip to content

Don't upgrade to Sphinx 3 #2749

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

Merged
merged 1 commit into from
Apr 7, 2020
Merged

Conversation

tannewt
Copy link
Member

@tannewt tannewt commented Apr 7, 2020

The doc build doesn't complete and is likely broken for the inline
RST. We can move to 3 when we move the inline docs to Python stubs.

The doc build doesn't complete and is likely broken for the inline
RST. We can move to 3 when we move the inline docs to Python stubs.
@tannewt tannewt added this to the 5.x.x - Bug Fixes milestone Apr 7, 2020
@tannewt tannewt requested a review from dhalbert April 7, 2020 18:50
Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

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

👍

@dhalbert dhalbert merged commit 78c1448 into adafruit:master Apr 7, 2020
@sommersoft
Copy link

I started pulling on this thread a little, and came across this commit: sphinx-doc/sphinx@2360473.

Seems like a direct cause of our Sphinx 3 issues. A little heavy-handed imo, and I'm surprised that there isn't a new issue opened up about it blocking other projects. However, I'm not sure if there was a better way for them to avoid this, even when a specific parser is supplied.

I'll spend some time looking through our docs to determine if we need header files for docs. The fix may be as simple as dropping .h from the source suffixes?

@tannewt
Copy link
Member Author

tannewt commented Apr 9, 2020

I did try to drop the .h files from the source suffix. It got past the error but hit other stuff that wasn't obvious how to fix. Specifically some of the code blocks in some markdown files were causing errors.

@kevinjwalters
Copy link

@sommersoft Is C and C++ a very limited part of sphinx userbase? I've seen people use doxygen before and MSFT world must do something similar.

@tannewt
Copy link
Member Author

tannewt commented Apr 9, 2020

@kevinjwalters Note, we don't actually use Sphinx for C. The .c suffix is there so the inline RST for the python interface can be stripped out.

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.

4 participants