executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
439 stars 201 forks source link

MAINT: Fix tests with updated upstream #766

Closed choldgraf closed 1 year ago

choldgraf commented 1 year ago

This updates our regression tests so that they pass. Will look at the diff and see if anything meaningful has changed. If not then I'll just merge so that we can inspect the other PRs more effectively.

choldgraf commented 1 year ago

This all looks to be cosmetic and based on changes in the pydata theme, so let's tackle any UI changes in subsequent PRs and merge this one if tests are happy.

choldgraf commented 1 year ago

@agoose77 any idea what the broken RTD error is? Here's the relevant bit, it seems to be choking when it tries to install pandas:

  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [15 lines of output]
      /tmp/pip-install-6ricahb1/pandas_c91e810c40ee4cf7a965f5b8bf5a9150/setup.py:12: DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html
        import pkg_resources
      /home/docs/checkouts/readthedocs.org/user_builds/sphinx-book-theme/envs/766/lib/python3.7/site-packages/setuptools/__init__.py:84: _DeprecatedInstaller: setuptools.installer and fetch_build_eggs are deprecated.
      !!

              ********************************************************************************
              Requirements should be satisfied by a PEP 517 installer.
              If you are using pip, you can try `pip install --use-pep517`.
              ********************************************************************************

      !!
        dist.fetch_build_eggs(dist.setup_requires)
      error in pandas setup command: 'install_requires' must be a string or list of strings containing valid project/version requirement specifiers; Expected end or semicolon (after version specifier)
          pytz >= 2011k
               ~~~~~~~^
      [end of output]
agoose77 commented 1 year ago

@choldgraf 23917da should do it! Not sure why the default is 3.7, but bumped the RTD Python version to 3.10

choldgraf commented 1 year ago

@agoose77 ah shit we just clobbered each other. I didn't realize you had pushed to this branch, sorry about that. I just updated to 3.10 in Sphinx and fixed some bugs that I think were in the pinned dependencies for our docs build (that I think no longer needed pinning). Let's see if that makes things happy.

choldgraf commented 1 year ago

OK readthedocs has some seriously wonky python version action going on. They only seem to support up to 3.8, and don't install it by default, even though one of our dependencies now requires a minimum of 3.8. So I really hope they resolve that one soon!

choldgraf commented 1 year ago

Well @agoose77 I'm back to the install_requires bug. If you wanna work your magic and fix it again that would be awesome, I promise to check and not to clobber your commit this time!

choldgraf commented 1 year ago

@agoose77 ahh I see, new config structure. OK I'm stepping away from the computer for a bit so feel free to merge and iterate if you like, otherwise I'll take a look when I get home to see if tests pass

choldgraf commented 1 year ago

Woot tests are happy, let's merge it and see how it impacts all of the other PRs :-) thanks @agoose77 for your help!

agoose77 commented 1 year ago

I promise to check and not to clobber your commit this time!

I do this all the time!

If you've not seen it, I use git push --force-with-lease, which doesn't force push if the remote has new changes!

choldgraf commented 1 year ago

oh wow I should overwrite git push -f with that haha