Skip to content

PRIORITY! SPHINX book: Create rss feed of pyOS tutorials #153

@lwasser

Description

@lwasser

GOAL: We have a list of tutorials published in the pyopensci package guide which is a sphinx book. We would also like to cross post tutorials on our website in the learn section. .

Right now to create this list on that page, i'm. manually adding stub md pages here.

Ideally we could parse a list of tutorials from either a RSS feed or the package guide sitemap.

The problem with using the sitemap is that there is no description of the file or title just a url. so that is why i think we'd want to create a custom sphinx feed for tutorials that the website could ingest.

I posted on fosstodon about generating RSS feeds of content - Hugo responded with the example from their PEP work

I don't know of such a tool, but it's not too complex: generate some static XML of the last X things and stick it online.

The main bit of code to generate https://peps.python.org/peps.rss is at https://github.com/python/peps/blob/main/pep_sphinx_extensions/generate_rss.py

It's now hooked up to the Sphinx build, previously it was a standalone script called during the build.
https://github.com/python/peps/pull/32

I think we can take this example and create a feed of tutorials that then we can read into the website to generate cards for each tutorial and critical packaging sections in our learn section (when we create that section).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancement-featuresomething new to add to our guidehelp wantedWe welcome a contributor to work on this issue! thank you in advance!sprintable

    Type

    No type

    Projects

    Status

    sphinx

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions