Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docbuild workflow broken because furo is too new #34092

Closed
mkoeppe opened this issue Jun 27, 2022 · 16 comments
Closed

Docbuild workflow broken because furo is too new #34092

mkoeppe opened this issue Jun 27, 2022 · 16 comments

Comments

@mkoeppe
Copy link
Member

mkoeppe commented Jun 27, 2022

As seen for example in
https://8f7574169b6743890bc32b58d9d2afcb4a5d6375--sagemath-tobias.netlify.app/

ERROR: This page was generated by inheriting from "layout.html".

Furo (the documentation theme that this site is generated with) does not support this, and has generated this page. If you are the author of this documentation, please look into why this page was generated using the "layout.html" template and fix the root cause.

Debugging information, if you need to report this error somewhere:
Sphinx: 4.4.0
Furo: 2022.06.21

pagename: index

As a workaround, we back out the use of furo on the docbuild CI.

CC: @tobiasdiez @kwankyu

Component: documentation

Author: Matthias Koeppe

Branch/Commit: 889fcc1

Reviewer: Kwankyu Lee

Issue created by migration from https://trac.sagemath.org/ticket/34092

@mkoeppe mkoeppe added this to the sage-9.7 milestone Jun 27, 2022
@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

New commits:

256ca4bbuild/pkgs/furo/requirements.txt: Set an upper bound

@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

Commit: 256ca4b

@mkoeppe

This comment has been minimized.

@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

Author: Matthias Koeppe

@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

comment:3

Also fails with Furo: 2022.04.07 - https://256ca4be1c5defc9de1f43a18a475258c5b19a00--sagemath-tobias.netlify.app/

@mkoeppe
Copy link
Member Author

mkoeppe commented Jun 27, 2022

comment:4

Or perhaps something else changed on our side since #33601?

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 30, 2022

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

889fcc1Revert "Use furo on ci"

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jun 30, 2022

Changed commit from 256ca4b to 889fcc1

@mkoeppe

This comment has been minimized.

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 1, 2022

comment:7

Okay. I have no idea either. It works locally well.

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 1, 2022

Reviewer: Kwankyu Lee

@mkoeppe
Copy link
Member Author

mkoeppe commented Jul 1, 2022

comment:8

Thanks!

@tobiasdiez
Copy link
Contributor

comment:9

This seems to only affect the index page, eg https://8f7574169b6743890bc32b58d9d2afcb4a5d6375--sagemath-tobias.netlify.app/reference/ is working. How is the starting page generated?

@kwankyu
Copy link
Collaborator

kwankyu commented Jul 2, 2022

comment:10

Replying to @tobiasdiez:

This seems to only affect the index page, eg https://8f7574169b6743890bc32b58d9d2afcb4a5d6375--sagemath-tobias.netlify.app/reference/ is working. How is the starting page generated?

Indeed. It is generated by sage_docbuild.WebsiteBuilder using the template src/doc/en/website/templates/index.html, which has the first line {% extends "layout.html" %}! It seems this line conflicts with the furo theme.

@vbraun
Copy link
Member

vbraun commented Jul 9, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants