From 6ece4e71162e579c88515a251553fe5e813d720f Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Thu, 18 Oct 2018 11:41:23 -0400 Subject: [PATCH] Use reno for release notes After we tag v0.1.0 we will start requiring reno notes moving forward for patches in this repo. Change-Id: I0f4aa54c3523197db14f9b9fec46ffe5230c3060 Signed-off-by: Thanh Ha --- docs/conf.yaml | 9 +++++++++ docs/index.rst | 1 + docs/release-notes.rst | 1 + docs/requirements.txt | 1 + tox.ini | 4 ++++ 5 files changed, 16 insertions(+) create mode 100644 docs/release-notes.rst diff --git a/docs/conf.yaml b/docs/conf.yaml index ed1f82c..fbcdb7a 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -1,3 +1,12 @@ --- project: lf-common-packer project_cfg: lfdocs + +extensions: + - reno.sphinxext + - sphinx.ext.autodoc + - sphinx.ext.doctest + - sphinx.ext.intersphinx + - sphinx.ext.todo + - sphinx.ext.coverage + - sphinx.ext.viewcode diff --git a/docs/index.rst b/docs/index.rst index 20664ab..5978e92 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,7 @@ projects as a central way to maintain and manage common VM configuration. .. toctree:: :maxdepth: 1 + release-notes requirements install usage diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..ec77acc --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1 @@ +.. release-notes:: Release Notes diff --git a/docs/requirements.txt b/docs/requirements.txt index 74a3b7a..01e8265 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ lfdocs-conf +reno~=2.11.2 diff --git a/tox.ini b/tox.ini index 95c7607..9858b01 100644 --- a/tox.ini +++ b/tox.ini @@ -33,3 +33,7 @@ whitelist_externals = echo [testenv:docs-linkcheck] deps = -rrequirements.txt commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + +[testenv:reno] +deps = -rdocs/requirements.txt +commands = reno {posargs:--help} -- 2.16.6