https://github.com/atsphinx/feed

Attakei's feed generator of Sphinx articles
https://github.com/atsphinx/feed

python sphinx sphinx-extension

Last synced: 4 months ago
JSON representation

Attakei's feed generator of Sphinx articles

• Host: GitHub
• URL: https://github.com/atsphinx/feed
• Owner: atsphinx
• License: apache-2.0
• Created: 2023-05-04T12:11:55.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-04T14:50:21.000Z (over 1 year ago)
• Last Synced: 2025-07-26T09:35:45.829Z (11 months ago)
• Topics: python, sphinx, sphinx-extension
• Language: Python
• Size: 101 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=============

atsphinx-feed

=============

Simple RSS feed generator based Open Graph.

Oviewview

=========

Sphinx extension to add RSS feed of documents.

This is using ``atsphin-og-article``, and pick documents included ``og-article`` directive.

You can select only documents that you want to notify as RSS.

Getting started

===============

Install from PyPI.

.. code:: console

   pip install atsphinx-feed

Configure your ``conf.py``.

.. code:: python

   extensions = [

       "atsphinx.feed",

       "atsphinx.og_article",

   ]

When you build by html-like builder, this generates Atom style feed file into outdir.

.. code:: text

  - _build/html/

    + index.html

    + atom.xml <- Generated!!

    - _static/

You can configure behevior of extension.

Please see docs.