Ticket History #9006: doc build fails with Sphinx 4.0.2

# Wed May 26 10:17:53 2021 Tomasz Kłoczko <kloczko.tomasz@gmail.com> - Ticket created

Subject:	krb5
To:	krb5-bugs@mit.edu
From:	"Tomasz Kłoczko" <kloczko.tomasz@gmail.com>
Date:	Wed, 26 May 2021 11:17:34 +0100

Download (untitled) / with headers
text/plain 980B

Download (untitled) / with headers
text/html 2.4KiB

Hi,

It would be really nice to open submitting issue tickets over github because submitting issues over email is hard to trace.

* Issue:

Looks like generate man pages using sphinx 4.0.2 fails

+ sphinx-build -a -b man -t pathsubs doc build-man
Running Sphinx v4.0.2
making output directory... done

Exception occurred:
  File "/home/tkloczko/rpmbuild/BUILD/krb5-1.19.1/doc/conf.py", line 102, in setup
    app.add_stylesheet('kerb.css')
AttributeError: 'Sphinx' object has no attribute 'add_stylesheet'
The full traceback has been saved in /tmp/sphinx-err-gmml44ha.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
error: Bad exit status from /var/tmp/rpm-tmp.ua2vw7 (%build)

kloczek

--

Tomasz Kłoczko | LinkedIn: http://lnkd.in/FXPWxH

# Wed May 26 10:41:27 2021 ghudson@mit.edu (Greg Hudson) - Subject changed from 'krb5' to 'doc build fails with Sphinx 4.0.2'

# Tue Jun 01 19:43:45 2021 ghudson@mit.edu (Greg Hudson) - Status changed from 'new' to 'resolved'

# Tue Jun 01 19:43:45 2021 ghudson@mit.edu (Greg Hudson) - Tags pullup added

# Tue Jun 01 19:43:45 2021 ghudson@mit.edu (Greg Hudson) - Taken

# Tue Jun 01 19:43:46 2021 ghudson@mit.edu (Greg Hudson) - Target_Version 1.19-next added

# Tue Jun 01 19:43:46 2021 ghudson@mit.edu (Greg Hudson) - Correspondence added

Subject:	git commit
From:	ghudson@mit.edu

Download (untitled) / with headers
text/plain 1KiB

Fix doc build for Sphinx 4.0

Use app.add_css_file() to register krb5.css if possible (it was added
in Sphinx 1.8), since the old name app.add_stylesheet() was removed in
Sphinx 4.0.

Use the highlight directive instead of the highlightlang directive,
which was removed in Sphinx 4.0.

Remove two duplicate table of contents entries to fix warnings.

In the Github Actions configuration, add a second doc build using the
newest version of Sphinx.

https://github.com/krb5/krb5/commit/3fa40a32e22cb9de91fa1d18deddcba446515855
Author: Greg Hudson <ghudson@mit.edu>
Commit: 3fa40a32e22cb9de91fa1d18deddcba446515855
Branch: master
.github/workflows/doc.yml | 15 +++++++++++++++-
doc/appdev/refs/macros/index.rst | 1 -
doc/appdev/refs/types/index.rst | 1 -
doc/appdev/refs/types/krb5_int32.rst | 2 +-
doc/appdev/refs/types/krb5_ui_4.rst | 2 +-
doc/conf.py | 9 ++++++++-
doc/tools/define_document.tmpl | 2 +-
doc/tools/type_document.tmpl | 2 +-
8 files changed, 27 insertions(+), 8 deletions(-)

# Mon Jul 12 12:29:06 2021 ghudson@mit.edu (Greg Hudson) - Version_Fixed 1.19.2 added

# Mon Jul 12 12:29:06 2021 ghudson@mit.edu (Greg Hudson) - Correspondence added

Subject:	git commit
From:	ghudson@mit.edu

Download (untitled) / with headers
text/plain 1.1KiB

Fix doc build for Sphinx 4.0

Use app.add_css_file() to register krb5.css if possible (it was added
in Sphinx 1.8), since the old name app.add_stylesheet() was removed in
Sphinx 4.0.

Use the highlight directive instead of the highlightlang directive,
which was removed in Sphinx 4.0.

Remove two duplicate table of contents entries to fix warnings.

In the Github Actions configuration, add a second doc build using the
newest version of Sphinx.

(cherry picked from commit 3fa40a32e22cb9de91fa1d18deddcba446515855)

https://github.com/krb5/krb5/commit/d72bb019d2381b93d60b2f40836cfb23873abfdb
Author: Greg Hudson <ghudson@mit.edu>
Commit: d72bb019d2381b93d60b2f40836cfb23873abfdb
Branch: krb5-1.19
.github/workflows/doc.yml | 16 +++++++++++++++-
doc/appdev/refs/macros/index.rst | 1 -
doc/appdev/refs/types/index.rst | 1 -
doc/appdev/refs/types/krb5_int32.rst | 2 +-
doc/appdev/refs/types/krb5_ui_4.rst | 2 +-
doc/conf.py | 9 ++++++++-
doc/tools/define_document.tmpl | 2 +-
doc/tools/type_document.tmpl | 2 +-
8 files changed, 27 insertions(+), 8 deletions(-)

# Mon Jul 12 13:04:01 2021 ghudson@mit.edu (Greg Hudson) - Tags pullup deleted