Support for ABlog

[damian-krawczyk]

Is your feature request related to a problem? Please describe.
n/a

Describe the solution you'd like
I would like furo theme to support ABlog. It would be good to support even the simplest form:

• properly formated list of posts on single page
• properly formated single article

Describe alternatives you've considered
n/a

Additional context
See examples of ABlog for Sphinx in use:

• https://www.ericholscher.com
• https://predictablynoisy.com/blog/

[pradyunsg]

You'll need to be more specific about what supporting ABlog would mean/need. What works right now, and what doesn't; why Furo needs to be the one that adds compatibility (rather than the other way round etc).

[damian-krawczyk]

@pradyunsg here I put more details with examples you can check how it works with default theme alabaster, pydata_sphinx_theme and error for furo theme.

[sudopluto]

https://github.com/pradyunsg/furo/blob/121edb3e9ade5e7cfc8c75d64190b66d0e7ddb08/docs/changelog.md#20210320beta31

is this relevant?

[sudopluto]

looks like (only?) two files to change: https://github.com/sunpy/ablog/search?q=layout.html

[errbufferoverfl]

@damian-krawczyk I recently made some changes to the furo theme to support ablog, as it currently stands it should work as both a normal Sphinx theme, and an ablog theme and did my best to ensure no breaking changes.

If you plan on testing it locally you'll need to follow the instructions on the workflow to get it to get all the Sass stylesheets and Javascript code working.

Good luck!

[damian-krawczyk]

At ablog's end Issue is tracked here sunpy/ablog#108

[stonecharioteer]

I just tried to use furo with ablog and got this error in the browser.

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.3.0
Furo: 2021.11.16

pagename: index

I'm uncertain if the change needs to happen at the furo end, the ablog end or if it needs to be done at the user end.
Any thoughts? @pradyunsg

[pradyunsg]

Furo doesn't use layout.html for anything. The "error" you're seeing comes from https://github.com/pradyunsg/furo/blob/main/src/furo/theme/furo/layout.html.

I think there is an assumption being made in ABlog, that every Sphinx theme will define the theme's scaffolding as layout.html, which is incorrect in this case.

[pradyunsg]

Looking more closely, ABlog is also making significant non-portable assumptions about how Sphinx themes would handle their blocks in Jinja, which is likely a part of the problem here.

[ABD-01]

Ablog with Furo

TL;DR

See ablog_with_furo

Body

Hi
I was facing a similar issue while using Ablog along with furo.

Based on comments from

• ABlog support for furo theme sunpy/ablog#108
• Support for ABlog #262
• stackoverflow, etc...

I forked Ablog and created ablog_with_furo

Now to use this I suggest using the exts directory as suggested by sphinx in their documentation

You can use submodule for this

git submodule add https://github.com/ABD-01/ablog_with_furo.git exts/ablog

For instance how I used it in my repo

I have also added meta data for posts below the title

You can view the Ablog's documentation build using furo here