Skip to content

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

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

Closed
lwasser opened this issue Jan 8, 2024 · 3 comments · Fixed by #488
Closed

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

lwasser opened this issue Jan 8, 2024 · 3 comments · Fixed by #488
Labels
enhancement-feature something new to add to our guide help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Jan 8, 2024

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).

@willingc willingc added sprintable enhancement-feature something new to add to our guide labels Jan 11, 2024
@lwasser lwasser added the help wanted We welcome a contributor to work on this issue! thank you in advance! label Apr 9, 2024
@lwasser lwasser moved this to Dev Ops / GitHub actions or GitHub related in pyOpenSci Help Wanted Project Board Apr 9, 2024
@lwasser lwasser changed the title Create rss feed of pyOS lessons SPHINX book: Create rss feed of pyOS tutorials May 20, 2024
@lwasser lwasser moved this from Dev Ops / GitHub actions or GitHub related to sphinx in pyOpenSci Help Wanted Project Board May 31, 2024
@lwasser lwasser changed the title SPHINX book: Create rss feed of pyOS tutorials PRIORITY! SPHINX book: Create rss feed of pyOS tutorials May 12, 2025
@lwasser
Copy link
Member Author

lwasser commented May 12, 2025

This is a high priority issue. I need to be able to cross-post content from our Sphinx books on our website to make it easier for people to discover. If we had a feed of tutorials and content, I could then generate stubs automatically on our website. We'd ideally want:

title, description and link to the content in the feed but maybe more! If we need to add yaml metadata with authors and keywords, we could do that too.

@sneakers-the-rat
Copy link
Contributor

got it #488

@lwasser
Copy link
Member Author

lwasser commented May 13, 2025

Oh wow!! thank you. I've wanted this for a long time. i'll check out the PR soon!! It's really hard to add things and keep it up to date manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement-feature something new to add to our guide help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable
Projects
Development

Successfully merging a pull request may close this issue.

3 participants