From 6483f4339aaf281249ccd68bc47776d3bdb16668 Mon Sep 17 00:00:00 2001 From: Bryon Tjanaka <38124174+btjanaka@users.noreply.github.com> Date: Sat, 27 Jan 2024 03:16:10 -0800 Subject: [PATCH] Fix Read the Docs build error (#455) ## Description Read the Docs had an error due to sphinxcontrib-applehelp. This PR also makes a note to check Read the Docs before deploying in the future. ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [N/A] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go --- CONTRIBUTING.md | 2 ++ setup.py | 1 + 2 files changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7de994019..8c0fc17c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -197,6 +197,7 @@ from `master` into the corresponding release branch. #### Minor Versions +1. Check that the latest version of the docs is building on Read the Docs. 1. Create a PR into master after doing the following: 1. Update the version with `bump2version`: ```bash @@ -228,6 +229,7 @@ from `master` into the corresponding release branch. #### Patch Versions +1. Check that the latest version of the docs is building on Read the Docs. 1. Create a PR into master after doing the following: 1. Update the version with `bump2version`: ```bash diff --git a/setup.py b/setup.py index ccdbe4c9f..c1292371a 100644 --- a/setup.py +++ b/setup.py @@ -60,6 +60,7 @@ "sphinx-toolbox==3.1.0", "sphinx-autodoc-typehints==1.18.2", "sphinx-codeautolink==0.12.1", + "sphinxcontrib-applehelp==1.0.4", # Distribution "bump2version==1.0.1",