Summary

Fix building docs on Python 3.

Review Request #11999 — Created Jan. 24, 2022 and submitted Jan. 31, 2022, 4:27 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-4.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The release notes and user manual can now be built on Python 3. There
were a couple string type issues leading to syntax errors, preventing
this from being built.

We also no longer hard-code a version of Python. We instead just run
sphinx-build.

An old reference to "Christian Hammond" as an author was also changed
to "Beanbag, Inc."

Testing Done

Built both sets of docs successfully.

Commits

Summary	ID
Fix building docs on Python 3. The release notes and user manual can now be built on Python 3. There were a couple string type issues leading to syntax errors, preventing this from being built. We also no longer hard-code a version of Python. We instead just run `sphinx-build`.	5d41ad5c125c22c08aef94c5b0e832f97dc78550

Issues

Description	From	Last Updated
These don't need to be raw strings.	david	Jan. 28, 2022, 6:15 p.m.
"Release Notes" and "Christian Hammond" don't need to be raw strings.	david	Jan. 28, 2022, 6:16 p.m.

flake8 passed.

JSHint passed.

docs/manual/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
These don't need to be raw strings.
```
docs/releasenotes/conf.py (Diff revision 1)
The issue has been resolved. Show all issues
```
"Release Notes" and "Christian Hammond" don't need to be raw strings.
```

Change Summary:


Changed raw strings to normal strings.
Switched my name out for "Beanbag, Inc." in the release notes LaTeX build.

Commits:

	Summary	ID
	Fix building docs on Python 3. The release notes and user manual can now be built on Python 3. There were a couple string type issues leading to syntax errors, preventing this from being built. We also no longer hard-code a version of Python. We instead just run `sphinx-build`.	3c1c0b7a2356888907759c5f3a9bbee2cb0d60fd
	Fix building docs on Python 3. The release notes and user manual can now be built on Python 3. There were a couple string type issues leading to syntax errors, preventing this from being built. We also no longer hard-code a version of Python. We instead just run `sphinx-build`.	5d41ad5c125c22c08aef94c5b0e832f97dc78550

Diff:

Revision 2 (+26 -32)

Show changes

	docs/manual/Makefile
	docs/manual/conf.py
	docs/releasenotes/Makefile
	docs/releasenotes/conf.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Description:: The release notes and user manual can now be built on Python 3. There
were a couple string type issues leading to syntax errors, preventing
this from being built.

We also no longer hard-code a version of Python. We instead just run
sphinx-build.
+
+
An old reference to "Christian Hammond" as an author was also changed
+ to "Beanbag, Inc."

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.0.x (31e483a)

		The release notes and user manual can now be built on Python 3. There
		were a couple string type issues leading to syntax errors, preventing
		this from being built.

		We also no longer hard-code a version of Python. We instead just run
		`sphinx-build`.
	+
	+	An old reference to "Christian Hammond" as an author was also changed
	+	to "Beanbag, Inc."

docs/manual/conf.py (Diff revision 1)

docs/releasenotes/conf.py (Diff revision 1)