From 9dc9b139a3b8e991a62c0375d65dece57870ca04 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Thu, 13 Sep 2018 11:18:53 -0400 Subject: [PATCH] Use reno for release notes Change-Id: I9f08ef7c04f815203ec3a0aba8284f9ea187cf77 Signed-off-by: Thanh Ha --- docs/conf.yaml | 9 +++++++++ docs/index.rst | 1 + docs/release-notes.rst | 1 + docs/requirements.txt | 1 + tox.ini | 5 +++++ 5 files changed, 17 insertions(+) create mode 100644 docs/release-notes.rst create mode 100644 docs/requirements.txt diff --git a/docs/conf.yaml b/docs/conf.yaml index 3edd414..8066718 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -1,3 +1,12 @@ --- project_cfg: lfdocs project: lfdocs-conf + +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 43b24dd..c361340 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,7 @@ Contents: .. toctree:: :maxdepth: 2 + release-notes install config 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 new file mode 100644 index 0000000..0f1068d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +reno~=2.10.0 diff --git a/tox.ini b/tox.ini index 7d46d2b..134aa14 100644 --- a/tox.ini +++ b/tox.ini @@ -33,7 +33,12 @@ commands = skip_install=True [testenv:docs] +deps = -rdocs/requirements.txt commands = sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo + +[testenv:reno] +deps = -rdocs/requirements.txt +commands = reno {posargs:--help} -- 2.16.6