Skip to content

Commit

Permalink
Fix Read the Docs build error (#455)
Browse files Browse the repository at this point in the history
## Description

<!-- Provide a brief description of the PR's purpose here. -->

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
  • Loading branch information
btjanaka authored Jan 27, 2024
1 parent f07d63b commit 6483f43
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 6483f43

Please sign in to comment.