MAINT: Update Circle and conf.py

[larsoner]

1. Fix bug with latest main CircleCI build where we used a deprecated way of putting the search in the navbar:

https://app.circleci.com/pipelines/github/numpy/numpydoc/287/workflows/e91a2751-3810-4e37-9ccb-f8f4e419ceb1/jobs/283

2. Add tinybuild to the CircleCI build. I wanted to look at the output so that I could see if the *args, **kwargs that show up in the API docs there render properly so that we can merge Be explicit about leading * when documenting *args, **kwargs. #310.

Closes #318

[codecov-commenter]

Codecov Report

❗ No coverage uploaded for pull request base (main@b7bbf45). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #319   +/-   ##
=======================================
  Coverage        ?   87.85%           
=======================================
  Files           ?        7           
  Lines           ?     1334           
  Branches        ?      320           
=======================================
  Hits            ?     1172           
  Misses          ?      104           
  Partials        ?       58           

[larsoner]

On latest main I see:

And this preserves the navbar search and icons, but with out the deprecation warning:

And the bugs mentioned in #318 are fixed:

And #310 looks to be correct, no need to escape as seen in the new tinybuild artifacts:

This looks pretty straightforward so I'll merge this tomorrow and then merge #310 unless folks have comments.

[rgommers]

I see Codecov is back with a new bot:( Banned from the SciPy GitHub org now. EDIT: misread repo, also banned from the NumPy org now.

[rgommers]

Add tinybuild to the CircleCI build. I wanted to look at the output so that I could see if the *args, **kwargs that show up in the API docs there render properly so that we can merge #310.

I had to search for what it was, still not sure. Here's the separate artifact: https://285-11639513-gh.circle-artifacts.com/0/tinybuild/index.html. What does this show that the regular doc build doesn't?

[larsoner]

I had to search for what it was, still not sure.

Basically tinybuild is part of the testing framework to make it easier to test new changes. Pretty much everything in tests/test_full.py make use of it and check the outputs:

https://github.com/numpy/numpydoc/blob/main/numpydoc/tests/test_full.py#L14-L16

I think it'll be useful check the output visually when changes are made to our code in addition to being able to check it programmatically, which is what we currently do in main.

It only adds 2s (1s for build, 1s for upload of artifacts) to the CircleCI build so it's negligible in terms of added time.

What does this show that the regular doc build doesn't?

In this case what it has that the main build does not is a *args, **kwargs in a class init constructor rendered by autosummary (screenshot above), i.e., the test case for showing that #310 (no need for escaping the asterisks) is proper advice. Our main doc build does not have this AFAIK. But even if it does somewhere, I still see value in having tinybuild artifacts available when looking at future PRs.

[larsoner]

Ahh I guess somehow autodoc does render a *args, **kwargs:

https://285-11639513-gh.circle-artifacts.com/0/html/example.html

Nonetheless I think it'll be useful to see tinybuild outputs in the future for 2 s of added CircleCI time

[rgommers]

Thanks for the explanation Eric, makes sense. In it goes.