Skip to content
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

Fix readthedocs documentation generation #486

Merged
merged 2 commits into from
Feb 2, 2024

Conversation

zhindes
Copy link
Collaborator

@zhindes zhindes commented Feb 2, 2024

What does this Pull Request accomplish?

It fixes readthedocs generation.

Why should this Pull Request be merged?

readthedocs has been failing for some time with this error:

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

Closes #487

What testing has been done?

Manually generating the documentation works. RTD pipeline seems happy.

@zhindes zhindes requested review from maxxboehme and bkeryan February 2, 2024 22:36
@bkeryan bkeryan linked an issue Feb 2, 2024 that may be closed by this pull request
@zhindes zhindes force-pushed the users/zhindes/update_sphinx branch from 8dd3552 to 2220e93 Compare February 2, 2024 22:46
@zhindes zhindes requested a review from bkeryan February 2, 2024 22:48
Copy link

github-actions bot commented Feb 2, 2024

Test Results

 10 files   -     20   10 suites   - 20   2m 51s ⏱️ - 30m 53s
 95 tests  -  1 147   95 ✅  -    967  0 💤  -   180  0 ❌ ±0 
950 runs   - 18 310  950 ✅  - 15 690  0 💤  - 2 620  0 ❌ ±0 

Results for commit 2220e93. ± Comparison against base commit 908cebf.

This pull request removes 1147 tests.
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path0]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path10]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path11]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path12]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path13]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path14]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path15]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path16]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path17]
tests.acceptance.test_examples ‑ test___shipping_example___run___no_errors[library_init_kwargs-example_path1]
…

@zhindes zhindes merged commit 8bc4799 into master Feb 2, 2024
15 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RTD build is failing due to Sphinx version
2 participants