Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC,BLD: pin sphinx to <3.0 in doc_requirements.txt #16216

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.

Sign up for GitHub

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
Merged
merged 1 commit into from
May 12, 2020
Merged

DOC,BLD: pin sphinx to <3.0 in doc_requirements.txt #16216

merged 1 commit into from
May 12, 2020

Conversation

rossbar
Copy link
Contributor

@rossbar rossbar commented May 12, 2020

Attempting to build the docs with Sphinx 3 raises a lot of warnings, particularly
re: the documentation for the C components. Pinning to sphinx 2 until
this is resolved.

@rossbar
DOC,BLD: pin sphinx to <3.0
ee1a7f5 
Attempting to build with Sphinx 3 raises a lot of warnings, particularly
re: the documentation for the C components. Pinning to sphinx 2 until
this is resolved.
@eric-wieser
Copy link
Member

Mind giving an example of some of the warnings?

@rossbar
Copy link
Contributor Author

rossbar commented May 12, 2020

Putting together a trimmed build log now to be included in an issue, but here's a short sample:

Invalid C declaration: Expected identifier in nested name. [error at 22]        
  NPY_ARRAY_C_CONTIGUOUS                                                        
  ----------------------^                                                       
repos/numpy/doc/source/reference/c-api/array.rst:436: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 22]        
  NPY_ARRAY_F_CONTIGUOUS                                                        
  ----------------------^                                                       
repos/numpy/doc/source/reference/c-api/array.rst:440: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 17]        
  NPY_ARRAY_ALIGNED                                                             
  -----------------^                                                            
repos/numpy/doc/source/reference/c-api/array.rst:447: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 19]        
  NPY_ARRAY_WRITEABLE                                                           
  -------------------^                                                          
repos/numpy/doc/source/reference/c-api/array.rst:451: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 20]        
  NPY_ARRAY_ENSURECOPY                                                          
  --------------------^                                                         
repos/numpy/doc/source/reference/c-api/array.rst:456: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 21]

@eric-wieser
Copy link
Member

So, this section: https://github.com/numpy/numpy/blob/master/doc/source/reference/c-api/array.rst#from-other-objects

I think the issue is that those constants are nested under a function declaration, so it tries to reference an inner scope.

@rossbar
Copy link
Contributor Author

rossbar commented May 12, 2020

Could be... it looks like Sphinx made some intentionally breaking changes to their c: directives in 3.0 that might be biting us as well - I was going to make an issue with the full log of warnings unless it's preferred that I just post it here?

@rossbar
Copy link
Contributor Author

rossbar commented May 12, 2020

The two main warnings seem to be Expected identifier in nested name (like above) or Expected end of definition

@rossbar
Copy link
Contributor Author

rossbar commented May 12, 2020

Opened an issue with the full log: #16217

@charris charris merged commit 94df933 into numpy:master May 12, 2020
@charris
Copy link
Member

charris commented May 12, 2020

Seems harmless to put this in until the problem is fixed.

@charris
Copy link
Member

charris commented May 12, 2020

Thanks Ross.

@eric-wieser
Copy link
Member

Thanks for filing the follow up too!

@rossbar rossbar deleted the bld/pin_sphinx2 branch May 13, 2020 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
04 - Documentation component: build
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rossbar @eric-wieser @charris