Metadata-Version: 2.3
Name: atsphinx-feed
Version: 0.1.2
Summary: Simple RSS feed generator based Open Graph.
Author-email: Kazuya Takei <myself@attakei.net>
Requires-Python: >= 3.9
Description-Content-Type: text/x-rst
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation :: Sphinx
Requires-Dist: atsphinx-og-article>=0.2
Requires-Dist: feedgen
Requires-Dist: sphinx
Requires-Dist: rst-pypi-ref ; extra == "doc"
Requires-Dist: beautifulsoup4 ; extra == "test"
Requires-Dist: lxml ; extra == "test"
Requires-Dist: pytest ==7.* ; extra == "test"
Project-URL: Home, https://github.com/atsphinx/feed
Provides-Extra: doc
Provides-Extra: test

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

