Skip to content

Commit

Permalink
fix readthedocs build (#448)
Browse files Browse the repository at this point in the history
## Overview

Issue seen on https://readthedocs.org/projects/birdhouse-deploy/builds/24109903/
`AttributeError: module 'docutils.nodes' has no attribute 'reprunicode'`

## Changes

**Non-breaking changes**
- docs: Fix version of `sphinx-mdinclude` to address incompatible `docutils` operation under ReadTheDocs Sphinx build.

**Breaking changes**
- n/a

## Related Issue / Discussion


  - See [docutils 0.21 changes](https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09).
  - See issue [sphinx-mdinclude#47](omnilib/sphinx-mdinclude#47)     and PR [sphinx-mdinclude#55](omnilib/sphinx-mdinclude#55).
  • Loading branch information
fmigneault authored Apr 19, 2024
2 parents 5a54a1f + 4c2cb0b commit 97ee8da
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@
[Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest)
------------------------------------------------------------------------------------------------------------------

[//]: # (list changes here, using '-' for each new entry, remove this when items are added)
## Fixes

- docs: Fix version of `sphinx-mdinclude` to address incompatible `docutils` operation under ReadTheDocs Sphinx build.

- See [docutils 0.21 changes](https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09).
- See issue [sphinx-mdinclude#47](https://github.com/omnilib/sphinx-mdinclude/issues/47)
and PR [sphinx-mdinclude#55](https://github.com/omnilib/sphinx-mdinclude/pull/55).

[2.2.0](https://github.com/bird-house/birdhouse-deploy/tree/2.2.0) (2024-04-18)
------------------------------------------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# extra requirements specifically for documentation purposes
sphinx-mdinclude
sphinx-mdinclude>=0.5.4

0 comments on commit 97ee8da

Please sign in to comment.