Skip to content

Fix rstcheck in Azure CI builds, update sphinx dep and docs to match - #8549

Merged
sklam merged 5 commits into
numba:mainfrom
stuartarchibald:wip/fix_rstcheck
Oct 28, 2022
Merged

Fix rstcheck in Azure CI builds, update sphinx dep and docs to match#8549
sklam merged 5 commits into
numba:mainfrom
stuartarchibald:wip/fix_rstcheck

Conversation

@stuartarchibald

@stuartarchibald stuartarchibald commented Oct 28, 2022

Copy link
Copy Markdown
Contributor

As title.

@stuartarchibald

stuartarchibald commented Oct 28, 2022

Copy link
Copy Markdown
Contributor Author

Doc build passed rstcheck using e5651ba, issue confirmed as jinja2 update from 3.0 to 3.3.

@stuartarchibald

stuartarchibald commented Oct 28, 2022

Copy link
Copy Markdown
Contributor Author

a5b9592 failed with:

Warning, treated as error:
/home/vsts/work/1/s/docs/source/extending/low-level.rst:62:duplicate object description of as_numba_type.register, other instance in extending/low-level, use :noindex: for one of them
make: *** [Makefile:53: html] Error 2

@stuartarchibald

stuartarchibald commented Oct 28, 2022

Copy link
Copy Markdown
Contributor Author

de5fd15 failed with:

Warning, treated as error:
/home/vsts/work/1/s/docs/source/reference/pysupported.rst:1241:Unparseable C cross-reference: 'char'
Invalid C declaration: Expected identifier in nested name, got keyword: char [error at 4]
  char
  ----^
make: *** [Makefile:53: html] Error 2

@stuartarchibald

stuartarchibald commented Oct 28, 2022

Copy link
Copy Markdown
Contributor Author

c36c01f deals with the issue in #8549 (comment), it's not ideal, as the :c:expr:`<type>` doesn't render particularly well in the docs, but it means that the docs now build with unpinned sphinx and docutils.

@stuartarchibald
Update docs for as_numba_type.register.
38784e1 
This merges the function and decorator docs as newer sphinx is
more strict and prevents duplicate entries.
@stuartarchibald
stuartarchibald marked this pull request as ready for review October 28, 2022 15:45
@stuartarchibald stuartarchibald changed the title Fix rstcheck step in Azure CI builds. Fix rstcheck in Azure CI builds, update sphinx dep and docs to match Oct 28, 2022
sklam
sklam approved these changes Oct 28, 2022
View reviewed changes

@sklam sklam left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the patch!

@sklam sklam added 5 - Ready to merge Review and testing done, is ready to merge 4 - Waiting on CI Review etc done, waiting for CI to finish and removed 3 - Ready for Review labels Oct 28, 2022
@stuartarchibald stuartarchibald added this to the Numba 0.57 RC milestone Oct 28, 2022
@stuartarchibald stuartarchibald linked an issue Oct 28, 2022 that may be closed by this pull request
Azure CI builds of main failing on rstcheck #8548
Closed
@stuartarchibald stuartarchibald removed the 4 - Waiting on CI Review etc done, waiting for CI to finish label Oct 28, 2022
@sklam
sklam merged commit 7a01756 into numba:main Oct 28, 2022
@stuartarchibald stuartarchibald mentioned this pull request Nov 1, 2022
Merged
@sklam sklam mentioned this pull request Nov 7, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sklam sklam sklam approved these changes

Assignees

No one assigned

Labels

5 - Ready to merge Review and testing done, is ready to merge Effort - short Short size effort needed

Projects

None yet

Milestone

Numba 0.57 RC

Development

Successfully merging this pull request may close these issues.

Azure CI builds of main failing on rstcheck

2 participants

@stuartarchibald @sklam