Summary

Add tox for testing, support Sphinx 6, and fix Sphinx version compatibility.

Review Request #12743 — Created Nov. 28, 2022 and submitted Jan. 10, 2023, 4:22 a.m.

Information

Owner

chipx86

Repository

beanbag-docutils

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

To help keep beanbag-docutils maintainable, a tox.ini has been added
to run the entire test suite against every supported combination of
Python and Sphinx.

Right now, we support Sphinx as far back as 1.8, for some of our older
codebases. So, this tests against each X.0.Z and the latest X.Y.Z of
each version series of Sphinx. We'll be dropping most of this in
beanbag-docutils 3.0.

Until then, some fixes have been included to make beanbag-docutils run
on some older versions of Sphinx, including the in-progress Sphinx 6
(which, currently, just requires unit test fixes).

Testing Done

All unit tests pass across all supported versions of Python and Sphinx.

Commits

Summary	ID
Add tox for testing, support Sphinx 6, and fix Sphinx version compatibility. To help keep beanbag-docutils maintainable, a `tox.ini` has been added to run the entire test suite against every supported combination of Python and Sphinx. Right now, we support Sphinx as far back as 1.8, for some of our older codebases. So, this tests against each X.0.Z and the latest X.Y.Z of each version series of Sphinx. We'll be dropping most of this in beanbag-docutils 3.0. Until then, some fixes have been included to make beanbag-docutils run on some older versions of Sphinx, including the in-progress Sphinx 6 (which, currently, just requires unit test fixes).	111194e7c61171fb0f4e458cdf0f49c1335df076

Summary

Add tox for testing, support Sphinx 6, and fix Sphinx version compatibility.

To help keep beanbag-docutils maintainable, a `tox.ini` has been added to run the entire test suite against every supported combination of Python and Sphinx. Right now, we support Sphinx as far back as 1.8, for some of our older codebases. So, this tests against each X.0.Z and the latest X.Y.Z of each version series of Sphinx. We'll be dropping most of this in beanbag-docutils 3.0. Until then, some fixes have been included to make beanbag-docutils run on some older versions of Sphinx, including the in-progress Sphinx 6 (which, currently, just requires unit test fixes).

111194e7c61171fb0f4e458cdf0f49c1335df076

Issues

Description	From	Last Updated
block comment should start with '# ' Column: 1 Error code: E265	reviewbot	Nov. 28, 2022, 5:42 a.m.

flake8 failed.

JSHint passed.

flake8

beanbag_docutils/sphinx/ext/autodoc_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
block comment should start with '# '

Column: 1
Error code: E265
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (50028b3)