From d8f004af753ec9c00ca2579577a9965cce6c53ff Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 10 Sep 2014 15:30:57 -0400 Subject: [PATCH] Add RSS feed Publish an RSS feed of the changes to the specs repository to make the specs more discoverable. Do not include the template in the toctree so it will not be included in the RSS feed. Use the doc build date to produce the copyright string instead of using a hard-coded value. Change-Id: Ib4f84efab8b3af3ddd47d38d63a91362612bd655 --- {{cookiecutter.repo_name}}/doc/source/conf.py | 14 ++++++++++++-- {{cookiecutter.repo_name}}/doc/source/index.rst | 1 - {{cookiecutter.repo_name}}/requirements.txt | 1 + 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/doc/source/conf.py b/{{cookiecutter.repo_name}}/doc/source/conf.py index 6b03973..18618e7 100755 --- a/{{cookiecutter.repo_name}}/doc/source/conf.py +++ b/{{cookiecutter.repo_name}}/doc/source/conf.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import datetime import os import sys @@ -23,7 +24,16 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'oslosphinx', + 'yasfb', +] + +# Feed configuration for yasfb +feed_base_url = 'http://specs.openstack.org/openstack/{{cookiecutter.repo_name}}' +feed_author = 'OpenStack Development Team' + +exclude_patterns = [ + 'template.rst', ] # Optionally allow the use of sphinxcontrib.spelling to verify the @@ -46,7 +56,7 @@ master_doc = 'index' # General information about the project. project = u'{{cookiecutter.repo_name}}' -copyright = u'2013, OpenStack Foundation' +copyright = u'%s, OpenStack Foundation' % datetime.date.today().year # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True diff --git a/{{cookiecutter.repo_name}}/doc/source/index.rst b/{{cookiecutter.repo_name}}/doc/source/index.rst index e5b2bda..4d116dc 100644 --- a/{{cookiecutter.repo_name}}/doc/source/index.rst +++ b/{{cookiecutter.repo_name}}/doc/source/index.rst @@ -21,7 +21,6 @@ README contributing - Sample Template