From 007da6c9132aa6c352721c2ea3081f4151ae40c1 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 28 Aug 2017 13:46:41 -0400 Subject: [PATCH] mark oslosphinx as obsolete We cannot remove the contents of master and retire the repository until we can turn off the test jobs, and we can't do that until the stable/pike branch is marked EOL. So, for now, update the README to indicate that the library should no longer be used. Change-Id: I3495ea4ff2b30cb3debbc3aaf0e73e9d2b6f4206 Signed-off-by: Doug Hellmann --- README.rst | 40 +++++-------------- .../notes/obsolete-3da30e6cd2867d0e.yaml | 6 +++ 2 files changed, 17 insertions(+), 29 deletions(-) create mode 100644 releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml diff --git a/README.rst b/README.rst index 93db1a8..de8f86c 100644 --- a/README.rst +++ b/README.rst @@ -1,35 +1,17 @@ -======================== -Team and repository tags -======================== - -.. image:: http://governance.openstack.org/badges/oslosphinx.svg - :target: http://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - ============================= OpenStack Sphinx Extensions ============================= -.. image:: https://img.shields.io/pypi/v/oslosphinx.svg - :target: https://pypi.python.org/pypi/oslosphinx/ - :alt: Latest Version +oslosphinx is obsolete. The openstackdocstheme package should be used +instead. oslosphinx will be maintained for the pike, ocata, and newton +release series and completely remove after that pike is marked +end-of-life. -.. image:: https://img.shields.io/pypi/dm/oslosphinx.svg - :target: https://pypi.python.org/pypi/oslosphinx/ - :alt: Downloads +The contents of this repository are still available in the Git source +code management system. To see the contents of this repository before +it reached its end of life, please check out the previous commit with +"git checkout HEAD^1", or check out one of the supported stable +branches. -Theme and extension support for Sphinx documentation from the -OpenStack project. - -Using the Theme -=============== - -Prior to using this theme, ensure your project can use the OpenStack -brand by referring to the brand guidelines at -http://www.openstack.org/brand. - -* Free software: Apache License, Version 2.0 -* Documentation: http://docs.openstack.org/developer/oslosphinx -* Source: http://git.openstack.org/cgit/openstack/oslosphinx -* Bugs: http://bugs.launchpad.net/oslosphinx +For any further questions, please email +openstack-dev@lists.openstack.org or join #openstack-oslo on Freenode. diff --git a/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml b/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml new file mode 100644 index 0000000..70f4461 --- /dev/null +++ b/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml @@ -0,0 +1,6 @@ +--- +prelude: >- + oslosphinx is obsolete. The openstackdocstheme package should be used + instead. oslosphinx will be maintained for the pike, ocata, and newton + release series and completely remove after that pike is marked + end-of-life.