Summary

Add a test helper to run within a Sphinx environment.

Review Request #12516 — Created Aug. 8, 2022 and submitted Aug. 14, 2022, 8:19 p.m.

Information

Owner

chipx86

Repository

beanbag-docutils

Branch

master

Bugs

Depends On

Blocks

12515

Reviewers

Groups

beanbag-misc

People

Description

This adds SphinxExtTestCase.with_sphinx_env(), a context manager that
sets up a Sphinx test environment and allows a caller to run within its
context.

It's a simplified version of the sphinx_testing.with_app() helper,
which was a bit too rigid for our uses.

The BeanbagDocstring tests now run within this environment, which will
be important for upcoming changes.

Testing Done

All unit tests pass.

Commits

Summary	ID
Add a test helper to run within a Sphinx environment. This adds `SphinxExtTestCase.with_sphinx_env()`, a context manager that sets up a Sphinx test environment and allows a caller to run within its context. It's a simplified version of the `sphinx_testing.with_app()` helper, which was a bit too rigid for our uses. The `BeanbagDocstring` tests now run within this environment, which will be important for upcoming changes.	00ae6e79d41b446179a98a04a83049148b08b7a8

Summary

Add a test helper to run within a Sphinx environment.

This adds `SphinxExtTestCase.with_sphinx_env()`, a context manager that sets up a Sphinx test environment and allows a caller to run within its context. It's a simplified version of the `sphinx_testing.with_app()` helper, which was a bit too rigid for our uses. The `BeanbagDocstring` tests now run within this environment, which will be important for upcoming changes.

00ae6e79d41b446179a98a04a83049148b08b7a8

Issues

Description	From	Last Updated
'sphinx.application.Sphinx' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 8, 2022, 7:57 p.m.
'sphinx.config.Config' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 8, 2022, 7:57 p.m.
'sphinx.ext.napoleon.Config as NapoleonConfig' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 8, 2022, 7:57 p.m.
'sphinx_testing.util.docutils_namespace' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 8, 2022, 7:58 p.m.

flake8 failed.

JSHint passed.

flake8

beanbag_docutils/sphinx/ext/tests/test_autodoc_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'sphinx.application.Sphinx' imported but unused

Column: 1
Error code: F401
```
beanbag_docutils/sphinx/ext/tests/test_autodoc_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'sphinx.config.Config' imported but unused

Column: 1
Error code: F401
```
beanbag_docutils/sphinx/ext/tests/test_autodoc_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'sphinx.ext.napoleon.Config as NapoleonConfig' imported but unused

Column: 1
Error code: F401
```
beanbag_docutils/sphinx/ext/tests/testcase.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'sphinx_testing.util.docutils_namespace' imported but unused

Column: 1
Error code: F401
```

Change Summary:


Removed unused imports.
Added usage of the docutils_namespace decorator to help set up docutils.

Commits:

	Summary	ID
	Add a test helper to run within a Sphinx environment. This adds `SphinxExtTestCase.with_sphinx_env()`, a context manager that sets up a Sphinx test environment and allows a caller to run within its context. It's a simplified version of the `sphinx_testing.with_app()` helper, which was a bit too rigid for our uses. The `BeanbagDocstring` tests now run within this environment, which will be important for upcoming changes.	5cec43b45d363d00b0b1a163d86afac1b7bd6841
	Add a test helper to run within a Sphinx environment. This adds `SphinxExtTestCase.with_sphinx_env()`, a context manager that sets up a Sphinx test environment and allows a caller to run within its context. It's a simplified version of the `sphinx_testing.with_app()` helper, which was a bit too rigid for our uses. The `BeanbagDocstring` tests now run within this environment, which will be important for upcoming changes.	00ae6e79d41b446179a98a04a83049148b08b7a8

Diff:

Revision 2 (+130 -54)

Show changes

	beanbag_docutils/sphinx/ext/tests/test_autodoc_utils.py
	beanbag_docutils/sphinx/ext/tests/testcase.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (8dbefcc)