Summary

Fix building docs on Python 3.

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

Information

Owner

chipx86

Repository

Djblets

Branch

release-2.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

The Djblets documentation can now be built with Python 3, providing
better compatibility with our documentation hosting.

This mostly involves changing the version used to invoke Sphinx,
fixing a couple syntax errors (Unicode string prefixes), and removing
the hard-coded python in the Makefiles.

The copyright for the release notes has also been fixed to include
"2009-<now>", and an old reference to "Christian Hammond" as an author
was changed to "Beanbag, Inc."

Testing Done

Successfully built all the documentation.

Commits

Summary	ID
Fix building docs on Python 3. The Djblets documentation can now be built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, fixing a couple syntax errors (Unicode string prefixes), and removing the hard-coded `python` in the `Makefile`s. The copyright for the release notes has also been fixed to include "2009-<now>", and an old reference to "Christian Hammond" as an author was changed to "Beanbag, Inc."	daebf03e9afeda518b9f9c5b785f0c755413441d

Summary

Fix building docs on Python 3.

The Djblets documentation can now be built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, fixing a couple syntax errors (Unicode string prefixes), and removing the hard-coded `python` in the `Makefile`s. The copyright for the release notes has also been fixed to include "2009-<now>", and an old reference to "Christian Hammond" as an author was changed to "Beanbag, Inc."

daebf03e9afeda518b9f9c5b785f0c755413441d

Issues

Description	From	Last Updated
Shouldn't this be copyright 2009-(current year)?	david	Jan. 28, 2022, 6:17 p.m.
These don't need to be raw strings.	david	Jan. 28, 2022, 6:18 p.m.
Shouldn't this be copyright 2009-(current year)?	david	Jan. 28, 2022, 6:18 p.m.
These don't need to be raw strings.	david	Jan. 28, 2022, 6:18 p.m.

flake8 passed.

JSHint passed.

Change Summary:

Removed the hard-coded python call in Makefiles.

Summary:

Use Python 3 to build Djblets documentation.

Fix building docs on Python 3.

Description:

~		The Djblets documentation is now built with Python 3, providing better
~		compatibility with our documentation hosting.
	~	The Djblets documentation can now be built with Python 3, providing
	~	better compatibility with our documentation hosting.

~		This mostly involves changing the version used to invoke Sphinx, and
~		fixing a couple syntax errors (Unicode string prefixes).
	~	This mostly involves changing the version used to invoke Sphinx,
	~	fixing a couple syntax errors (Unicode string prefixes), and removing
	+	the hard-coded `python` in the `Makefile`s.

Commits:

	Summary	ID
	Use Python 3 to build Djblets documentation. The Djblets documentation is now built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, and fixing a couple syntax errors (Unicode string prefixes).	882266585eb2538f9f5b43ab0bc4bf83f2f20f98
	Fix building docs on Python 3. The Djblets documentation can now be built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, fixing a couple syntax errors (Unicode string prefixes), and removing the hard-coded `python` in the `Makefile`s.	d52358f5541431cfd423b5b810ea6c44d213757c

Diff:

Revision 2 (+20 -24)

Show changes

	docs/djblets/Makefile
	docs/djblets/conf.py
	docs/releasenotes/Makefile
	docs/releasenotes/conf.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/djblets/conf.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Shouldn't this be copyright 2009-(current year)?
```
docs/djblets/conf.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These don't need to be raw strings.
```
docs/releasenotes/conf.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Shouldn't this be copyright 2009-(current year)?
```
docs/releasenotes/conf.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These don't need to be raw strings.
```

Change Summary:


Changed some raw strings to normal strings.
Updated copyrights to be "2009-<year>".
Changed an old author reference to say "Beanbag, Inc." instead of my name.

Description:

		The Djblets documentation can now be built with Python 3, providing
		better compatibility with our documentation hosting.

		This mostly involves changing the version used to invoke Sphinx,
		fixing a couple syntax errors (Unicode string prefixes), and removing
		the hard-coded `python` in the `Makefile`s.
	+
	+	The copyright for the release notes has also been fixed to include
	+	"2009-<now>", and an old reference to "Christian Hammond" as an author
	+	was changed to "Beanbag, Inc."

Commits:

	Summary	ID
	Fix building docs on Python 3. The Djblets documentation can now be built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, fixing a couple syntax errors (Unicode string prefixes), and removing the hard-coded `python` in the `Makefile`s.	d52358f5541431cfd423b5b810ea6c44d213757c
	Fix building docs on Python 3. The Djblets documentation can now be built with Python 3, providing better compatibility with our documentation hosting. This mostly involves changing the version used to invoke Sphinx, fixing a couple syntax errors (Unicode string prefixes), and removing the hard-coded `python` in the `Makefile`s. The copyright for the release notes has also been fixed to include "2009-<now>", and an old reference to "Christian Hammond" as an author was changed to "Beanbag, Inc."	daebf03e9afeda518b9f9c5b785f0c755413441d

Diff:

Revision 3 (+20 -24)

Show changes

	docs/djblets/Makefile
	docs/djblets/conf.py
	docs/releasenotes/Makefile
	docs/releasenotes/conf.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-2.x (8a3d284)

docs/djblets/conf.py (Diff revision 2)

docs/djblets/conf.py (Diff revision 2)

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

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