diff --git a/.gitignore b/.gitignore index 54989faa2fdbbbc7d3cb56168e66bfd36e53095b..3c7c80d38949464b5e5924ebf537391d5cf10bbb 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,5 @@ doc/source/api/tests.*.rst doc/source/api/autoindex.rst doc/source/sourcecode *.mo +.update-venv +releasenotes/build diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000000000000000000000000000000000000..29a43acdb9a7a4d6a7e869c7b137ecb2c2fe2653 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,16 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/oslosphinx diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 393e4dc5dec26dafcc1f4528fb67a8663df36aec..0000000000000000000000000000000000000000 --- a/MANIFEST.in +++ /dev/null @@ -1,4 +0,0 @@ -recursive-include oslosphinx *.html *.css *.js *.conf *.jpg *.gif -include AUTHORS -include HACKING.rst -include ChangeLog diff --git a/README.rst b/README.rst index 8fbf921b20677902c9df90874c20e470651218ca..de8f86c18385471ad0b7a8b993f4cb8c7bc7fd8c 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,17 @@ -OpenStack Sphinx Extensions -=========================== +============================= + OpenStack Sphinx Extensions +============================= -Theme and extension support for Sphinx documentation from the -OpenStack project. +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. -To use the theme, add ``'oslosphinx'`` to the ``extensions`` list in -the ``conf.py`` file in your Sphinx project. +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. -If you are an incubating project, set: - -``html_theme_options = {'incubating': True}`` in your conf.py as well, to enable the Incubation theme. +For any further questions, please email +openstack-dev@lists.openstack.org or join #openstack-oslo on Freenode. diff --git a/debian/CHANGELOG b/debian/CHANGELOG new file mode 100644 index 0000000000000000000000000000000000000000..34b4ab849798f04161dd4d188130a568fde480dc --- /dev/null +++ b/debian/CHANGELOG @@ -0,0 +1,1055 @@ +commit e2ded8e3074d5b50802e615803d73ca4587d94f3 +Author: OpenStack Proposal Bot +Date: Tue Jun 21 18:04:46 2016 +0000 + + Updated from global requirements + + Change-Id: Icaf8086589d629798108ead9e1c57e3d1a19cae4 + +commit d901a7bd61db6a60e909978ffa9cd0e340519cfc +Author: Joshua Harlow +Date: Wed Jun 1 15:15:40 2016 -0700 + + Subprocess returns bytes in py3 + + When later used the current code will break in + python3 due to: + + TypeError: 'str' does not support the buffer + interface + + Change-Id: I11572dd510ce8255ed66de56d5d9000755f7fee2 + +commit c327f858e6934d2558267e91085d588077921c89 +Author: OpenStack Proposal Bot +Date: Tue May 17 14:09:18 2016 +0000 + + Updated from global requirements + + Change-Id: Ie5922a24122950c6ab82637d818bdac284a469f2 + +commit 75cfb9f93b3560ff412cae4de3029157c14b258f +Author: John Dickinson +Date: Fri May 6 16:49:48 2016 -0700 + + add recent versions links to sidebar + + The last five tags (that start with a number) are used as version + numbers and linked to. This updates the sphinx extension so that + every user of the theme gets this info automatically with no need + to update the conf.py on a per-project basis. + + Change-Id: I9bf17872bd23bed3cab9b5e2349d615c7001cb66 + +commit 8084f2a4685f20f5fce60d292d2771e7c58fb701 +Author: Eric Brown +Date: Wed Feb 3 14:49:04 2016 -0800 + + Add version and download badges to README + + All the other oslo libraries contain such badges, so might as well + add to oslosphinx too. + + Change-Id: I23fa8dc4619940896fb25af39325f076f4dd3e49 + +commit 7de972255141e462e68ac7a04e25ce2b13bc911a +Author: Brant Knudson +Date: Mon Feb 1 14:39:14 2016 -0600 + + Correct project source guessing for OpenStack + + The links to the project source in all the developer docs are + incorrect. The link for keystone is like + + http://git.openstack.org/cgit/p/openstack/keystone + + when it should be + + http://git.openstack.org/cgit/openstack/keystone + + See the link to "Project Source" on the left on + http://docs.openstack.org/developer/keystone/ for example. + + Also, developers sometimes use a ".git" URL when they clone so + strip off the .git. + + Change-Id: I8e7620119a169e3322d602ea633303cf9f941605 + +commit 6903e98bfbf1e5e5386c256ec5ee6a53ce6e9ec6 +Author: OpenStack Proposal Bot +Date: Sat Jan 16 03:31:36 2016 +0000 + + Updated from global requirements + + Change-Id: I086cc0a93b00abc16c2bf9aa03a95d23c8455d44 + +commit b73bfc5cc9348e6a099151eb3cb3cf919fdc42c1 +Author: OpenStack Proposal Bot +Date: Tue Dec 15 18:16:34 2015 +0000 + + Updated from global requirements + + Change-Id: Ifb3265b0f0849e5e9aac97574ae457a4e4415130 + +commit 422df5892c7b2090889f8a0236a271f9bad7b934 +Merge: ea01f15 bd5fad6 +Author: Jenkins +Date: Mon Dec 14 05:03:36 2015 +0000 + + Merge "Deprecated tox -downloadcache option removed" + +commit bd5fad6e3ffd53d413ee2f5b833e68bb508da488 +Author: Ondřej Nový +Date: Fri Dec 11 21:06:13 2015 +0100 + + Deprecated tox -downloadcache option removed + + Caching is enabled by default from pip version 6.0 + + More info: + https://testrun.org/tox/latest/config.html#confval-downloadcache=path + https://pip.pypa.io/en/stable/reference/pip_install/#caching + + Change-Id: Ic8aa835bbc689246afa8fa8ebd9420c1bb1327a9 + +commit ea01f15dfeab37fad774d736eafff402575eb115 +Author: sonu.kumar +Date: Fri Dec 11 16:23:21 2015 +0530 + + Removes MANIFEST.in as it is not needed explicitely by PBR + + This patch removes `MANIFEST.in` file as pbr generates a sensible + manifest from git files and some standard files and it removes + the need for an explicit `MANIFEST.in` file. + + Change-Id: I38b985cc915cbccfa6ba83ae0cffbd72128f146e + +commit 2fbfcf568f78b68b54978ea1e43c6a682c3f650b +Author: briancurtin +Date: Tue Dec 8 15:27:52 2015 -0600 + + Use proper decode function name. + + os.fdecode is not a real thing, os.fsdecode is. + + Change-Id: I20b3b6d15b7d5775e1f6f97190d9acc62ca3a4ca + +commit f8d71ac5ad023a32cbbe04e109eb2793433ee558 +Author: Doug Hellmann +Date: Tue Dec 1 16:34:54 2015 +0000 + + trap errors from git not being present + + subprocess raises OSError if the command it is asked to run isn't found, + so trap that as well as the subprocess-specific error we were already + catching. + + Change-Id: Ieb9c7f3ccc307250847104a7f97cfa28603fcf5d + Closes-Bug: #1521541 + +commit 23539cbb14c1258f24f0c2c9928e5235bdbb419c +Author: OpenStack Proposal Bot +Date: Fri Nov 27 22:41:34 2015 +0000 + + Updated from global requirements + + Change-Id: I97cb7c94fb4d2b23a289fd05ed5e1060a064118a + +commit 10d552993479e07a14a0492f1242ee752d4b9940 +Author: Cyril Roelandt +Date: Wed Nov 18 17:06:23 2015 +0100 + + Fix a string vs bytes issue in _guess_cgit_link + + subprocess.check_output returns bytes, so we end up using '+' on a text + string (CGIT_BASE) and bytes (the output of parsed.path) in + _guess_cgit_link. Make sure we decode 'git_remote' in Python 3. + + Change-Id: I9e846e2192ead41ca2328b8aa20994742096c51e + Closes-Bug: #1517525 + +commit da4cfa3f97dfa7454d40fc430e35e4f31cb0c1e4 +Author: ChangBo Guo(gcb) +Date: Tue Nov 17 15:46:21 2015 +0800 + + Remove Python 2.6 classifier + + We have decided to remove Python 2.6 support, this commit + removes Python 2.6 classifier before dropping any Python + 2.6 support in code. + + Change-Id: I31d54e5fb1f18e49df42fef2863e70af6b2fdea1 + +commit 2378e5a9d7c5345ae65566026a23e541ad0b3eff +Merge: 0b555a0 a3f3bf8 +Author: Jenkins +Date: Tue Nov 17 01:50:18 2015 +0000 + + Merge "cleanup tox.ini" + +commit 0b555a001f5c2bf9bbc6464e8be5aae04c805f35 +Author: Doug Hellmann +Date: Tue Nov 17 01:06:00 2015 +0000 + + fix html context event handler + + The event handler should return a replacement template *name* or None. + Since we don't want to change the template, return None. + + Change-Id: I3012ad22505230c488aa4babbd4141d903b7ab0d + Closes-Bug: 1516834 + +commit a3f3bf8b1dde3644704ff89ed3567e64223b0ac8 +Author: Davanum Srinivas +Date: Sun Nov 15 10:21:11 2015 -0500 + + cleanup tox.ini + + * Remove usedevelop : only needed when skipsdist + is set to True + * Remove install_command : We can just use the + default, we don't need to override + * Remove setenv : We can just use the default as + we don't need any extra environment variables + * sitepackages : default is already false + + + Change-Id: Id13307a8f7c21496e1d5aad20cd9e2146b8f2fbd + +commit c383e0026aeb9fb541486f41cf286256e312e5e3 +Author: Doug Hellmann +Date: Fri Oct 16 20:37:34 2015 +0000 + + add config option to point to the cgit browser + + Add a configuration option to let projects set the URL to the cgit + browser for their source. Still try to guess at the location based on + our git URL. + + Change-Id: I11455f8a137a029c28a864eb555f69f6c282840b + +commit cd2674bb9501b0216dc81ede635e84c379b6309d +Author: Doug Hellmann +Date: Mon Oct 12 19:50:40 2015 +0000 + + fix html-page-context event handler + + The event handler should return a string if it wants to replace the + template, but should otherwise return None and update the context in + place. + + Change-Id: Ic4b19c7d19eda866ba139913cf817c99a65c8c08 + Closes-Bug: #1505311 + +commit 53c4ae72e9940c917c8b4fc9a48b8aa4eeda7c81 +Author: OpenStack Proposal Bot +Date: Fri Oct 9 05:04:02 2015 +0000 + + Updated from global requirements + + Change-Id: Ib8e15a9f3da8800687d4244540b7a8aa902e5d14 + +commit 014df1a17447a5186f4545f7e32727e7f02dd547 +Author: Davanum Srinivas +Date: Sun Oct 4 19:40:10 2015 -0400 + + No need for Oslo Incubator Sync + + We can remove openstack-common.conf as we don't + sync any code from oslo-incubator any more. + + Change-Id: I600132f6c59bc8adf06c1edbe488fba0d5ee795b + +commit 2525bb98d17c239e45342e4191bd946e74484a9e +Author: Javier Pena +Date: Mon Sep 28 10:56:05 2015 +0200 + + Make urlparse import Python3-compatible + + urlparse moved to urllib.parse, so the current code fails in + Python3. Using six to ensure compatibility. + + Related-Bug: #1426898 + + Change-Id: I9297c886dcc361238e942cb8162f589072001094 + +commit b0f3ed9cca78e9239ffd779906ffbae89c3dab6a +Merge: 36dd92b ff59f30 +Author: Jenkins +Date: Fri Sep 25 21:00:11 2015 +0000 + + Merge "Titles in table of contents continue into the page" + +commit 36dd92b1e1e6dcb705ca71cb5ae5fb517c259e4d +Author: Javier Pena +Date: Fri Sep 25 16:23:18 2015 +0200 + + Fix subprocess exception name + + https://review.openstack.org/227299 added code using + subprocess.CheckedProcessException, which does not exist. From + the Python documentation, it should be + subprocess.CalledProcessError [1] + + [1] - https://docs.python.org/2/library/subprocess.html#subprocess.CalledProcessError + + Change-Id: I0e03f048a33b1b919e38d22038650a633b8ac5fd + +commit ff59f302c48dea4723381fa036ad7bf5e13c128e +Author: THOMAS J. COCOZZELLO +Date: Thu Sep 24 07:47:28 2015 -0500 + + Titles in table of contents continue into the page + + In the table of contents the titles are covering words + in the page, this won't be a problem but the directories + that are in the table of contents are considered 1 word + so it does not word wrap automatically + + Change-Id: I763aa1ba4418be1ea70d1ff48a321971630ec6e4 + Closes-Bug: 1498654 + +commit 6ffe7dd4f3b99101d814d8648f22f140d9c1dcdc +Merge: 6ebaef6 efec9c6 +Author: Jenkins +Date: Fri Sep 25 09:55:19 2015 +0000 + + Merge "add link to project source in navigation sidebar" + +commit 6ebaef6ba4edb4e336a23d34418519e05977e8c1 +Author: Doug Hellmann +Date: Thu Sep 24 19:41:44 2015 +0000 + + clean up documentation titles and intros + + Change-Id: I9f1bf4e912e53500f603cecb23f86b48d5dbc159 + +commit fa83ee0dc54e6e11ad53ad01540d3d6e07f89b02 +Author: Doug Hellmann +Date: Thu Sep 24 19:41:29 2015 +0000 + + add pbr-generated release history to the doc build + + Change-Id: I5d24d269a3861c56df0a08fb7e1dcc86e1336e36 + +commit efec9c68fe2fcc51c147c0b20228a57be60ff2db +Author: Doug Hellmann +Date: Thu Sep 24 13:21:42 2015 +0000 + + add link to project source in navigation sidebar + + Change-Id: I841f0e63259d6b79c55b223c8e7266c8520a668d + Closes-Bug: #1426898 + +commit e9e52bd118fdf8ae8c14ec3706e0e95cf757fddb +Author: OpenStack Proposal Bot +Date: Thu Sep 17 12:16:20 2015 +0000 + + Updated from global requirements + + Change-Id: Id34a666b95d54872619a505dcf30fde391fddd5b + +commit 3f9bccefc9f2bf5f2fbff1eb6cf6d35db39fa3fd +Author: OpenStack Proposal Bot +Date: Wed Aug 26 14:08:08 2015 +0000 + + Updated from global requirements + + Change-Id: Idaa1f7f8c45759bbb2af4abda7a635c5f92aec6f + +commit 66f688aedcf3af7a96183f6561d05e539db90eb6 +Author: OpenStack Proposal Bot +Date: Mon Aug 10 01:09:50 2015 +0000 + + Updated from global requirements + + Change-Id: Id53b19b67a2dd99d568141d6d36b0cdb720dcf27 + +commit 4436e1161bf14d232edab035199cf59b32436efa +Author: OpenStack Proposal Bot +Date: Wed Jul 15 00:29:02 2015 +0000 + + Updated from global requirements + + Change-Id: I45aab8ced05719e3189bb129afea54f8070f0b85 + +commit 01d3a5a662044535db26d4c8c828632401e6d2fa +Author: OpenStack Proposal Bot +Date: Mon Jun 22 08:27:25 2015 +0000 + + Updated from global requirements + + Change-Id: I7889ee5c3e1d9c686451149beaca09ba136026ec + +commit 774a129dcab04116fa7bcceaacb2fecaba391300 +Author: OpenStack Proposal Bot +Date: Tue Jun 16 17:26:12 2015 +0000 + + Updated from global requirements + + Change-Id: Ie2cca4e8cb2eade195cee152b54c6f567a11dc6f + +commit af39c45cca2a77a78c062f9865f23a987e3613f7 +Merge: f14ad41 46832a8 +Author: Jenkins +Date: Wed May 27 21:05:05 2015 +0000 + + Merge "Drop incubating theme option" + +commit 46832a8942c5f56f2cc8d1689304c57ab5c38c7e +Author: Joe Gordon +Date: Wed May 27 12:18:31 2015 -0700 + + Drop incubating theme option + + OpenStack has dropped the incubation concept, so drop this label as a + docs option. + + Change-Id: Ib95bb403d51ed3c7b682dd695713f43432cf8a4e + +commit f14ad415adc246572c9eb85bdda9be2c4bcf9280 +Author: Jeremy Stanley +Date: Thu May 14 21:38:20 2015 +0000 + + Replace ci.o.o links with docs.o.o/infra + + The http://ci.openstack.org/ documentation site has been deprecated, + replaced by redirects to corresponding paths within + http://docs.openstack.org/infra/ where other Project Infrastructure + documentation already resides. + + Change-Id: Ia914d1802b57f7101dd86b2098857dd714763dd1 + +commit 6a1260bcc8abd81f7af2dd66f0f70dbc3b77b759 +Merge: c9d9c55 33845ab +Author: Jenkins +Date: Tue May 12 20:12:34 2015 +0000 + + Merge "Remove the unneeded horizontal scrollbar" + +commit c9d9c557aadb47308db32151547fff321cc36118 +Merge: 34f8618 495aec3 +Author: Jenkins +Date: Tue May 12 18:42:24 2015 +0000 + + Merge "Advertise support for Python3.4 / Remove support for Python 3.3" + +commit 34f8618ed1a3722939c855edcca17ce8767a133d +Merge: d79b8cc 90a1e5d +Author: Jenkins +Date: Mon May 11 20:18:37 2015 +0000 + + Merge "Remove run_cross_tests.sh" + +commit 495aec3b4381889c06a6002dd687a59b843d427d +Author: Davanum Srinivas +Date: Fri May 8 16:08:21 2015 -0400 + + Advertise support for Python3.4 / Remove support for Python 3.3 + + Change-Id: I2e5d3e5409cf08c69703f8cdf0ace0c2ac65f900 + +commit d79b8cc3ffe01a8a6e1911492413c9f01c0ecd15 +Author: OpenStack Proposal Bot +Date: Thu May 7 23:36:54 2015 +0000 + + Updated from global requirements + + Change-Id: I53fe1ede93a10518c4d97db8027034e380a06566 + +commit 90a1e5d5f517313f2c2a77918d97bae94a722417 +Author: Doug Hellmann +Date: Fri May 1 19:39:53 2015 +0000 + + Remove run_cross_tests.sh + + This script is part of the oslotest package now. + + Change-Id: I14681b35dbcc9290adc59b77f73e1580a1f46acf + +commit 6e76e425d7e4591243b3e57ccce0829605222d3a +Author: OpenStack Proposal Bot +Date: Mon May 4 20:08:42 2015 +0000 + + Updated from global requirements + + Change-Id: I1cca99b86c395d0025fcb73575e036e30b2cdb36 + +commit 33845ab55c238fffe746969600da5233e8c5e94b +Author: Dougal Matthews +Date: Thu Apr 9 15:15:25 2015 +0100 + + Remove the unneeded horizontal scrollbar + + Even on really large screens, the horizontal scrollbar is shown. This is + because the `div.related` class has a width of 100% in basic.css and in + tweaks.css a border is also defined. This causes the div to be two pixes + wider than the screen. + + Change-Id: I2881d8eca99988ff8372b22aecc1a1a90c66a314 + +commit 7ddfe1c965474f28a5a4a25062e0c35243ad6452 +Author: Anne Gentle +Date: Wed Apr 8 16:27:26 2015 -0500 + + Adds javascript footer for Google Analytics tracking + + - Ensures tracking is across all openstack.org web properties + - Tracks only docs.openstack.org/developer/{{ project }} where + project name is taken from conf.py + + Change-Id: Idfb2696f42ff17cbc6c3b72afcd2630b9ae01f0e + Closes-bug: 1441315 + +commit 199235c021e8b193eeea3eeef7e3aaa36cf40721 +Author: Doug Hellmann +Date: Fri Apr 3 14:12:14 2015 +0000 + + Update to latest hacking + + Change-Id: Ib077c249bcb7ca5f8f795bf94c75f7f1d15a5746 + +commit e1b0dca451f2a492f5761950077eb6e721b64f60 +Author: Doug Hellmann +Date: Tue Feb 24 18:52:53 2015 -0500 + + Speed up blueprint checking with naming convention + + If the blueprint file is named beginning with the name of a project, + look there for the blueprint first. + + Change-Id: I49cf48ed001945670ab900fcc76cd4c2087ddbb7 + +commit 7312f510e0f0025b43fbde2ea899a258b994f741 +Merge: 7c282dc ccf8e1a +Author: Jenkins +Date: Fri Jan 30 17:21:12 2015 +0000 + + Merge "Update run_cross_tests.sh to latest" + +commit 7c282dc14a0c7a718a2f477e958822e4cf186d2a +Author: Doug Hellmann +Date: Mon Jan 26 17:10:43 2015 -0500 + + Allow alternate OpenStack themes + + By default oslosphinx forces projects that use it to use the theme + contained in the package. The documentation team wants to provide a + separate theme for some parts of the docs.openstack.org site. They are + going to distribute it in their own package, but do still want to be + able to use other features of oslosphinx. This change allows any name + that starts "openstack" to be used, while retaining the default behavior + of inserting the "openstack" theme if a project is using a different + default or has not set a theme. + + Change-Id: I7a2c5a5c3805685b8fa0baaa47393d5fec312f30 + +commit ccf8e1a8a957100164e7bbc72f5861b028c009a9 +Author: Doug Hellmann +Date: Tue Jan 20 13:18:54 2015 -0500 + + Update run_cross_tests.sh to latest + + Change-Id: I0f660fde6bae0cc5a4aa1b7deb9f94d3ffee0bc5 + +commit f640b5e3f8b374892645549693bb557efdc448db +Merge: 33d4850 7275016 +Author: Jenkins +Date: Fri Jan 16 18:36:23 2015 +0000 + + Merge "Add run_cross_tests.sh from incubator" + +commit 33d48509bcf0e6afe7637ce4ec2c072c8412fc3a +Merge: c01c226 4ce81f8 +Author: Jenkins +Date: Sun Jan 11 20:31:19 2015 +0000 + + Merge "Add an extension for validating blueprint names" + +commit c01c2265383fab6414d715cbb08ae8b294b1921c +Author: Doug Hellmann +Date: Tue Dec 2 11:32:10 2014 -0500 + + Add links to the README + + Add a few links to resources for the project so humans can find them but + also so the release notes script will find them. + + Change-Id: If5fb9387e9ffb5c9288632beaa1b6d4e90d48033 + +commit 72750165445f4c39e2b830c82daadf1d3fa2786a +Author: Doug Hellmann +Date: Tue Dec 9 10:06:48 2014 -0500 + + Add run_cross_tests.sh from incubator + + Import run_cross_tests.sh from the incubator to make it easier to test + the theme and other extensions against existing repositories. + + Change-Id: Ic36c8950d7cdafcfe74f88ed7dde00f98534b2af + +commit 4ce81f85fbee729a443d5c6e2f20fb328f18a9db +Author: Doug Hellmann +Date: Tue Dec 9 09:55:54 2014 -0500 + + Add an extension for validating blueprint names + + This new extension requires spec filenames to match blueprint names in + the relevant project. This is based on work originally done in + oslo-specs under https://review.openstack.org/#/c/138392/ + + Change-Id: Ifd58f4f71f661229f09ecf01047bc7a7b1dc0b08 + +commit 879cbc5e9a0683941cfe32c7aaa5940bcbeecfd3 +Author: Jeremy Stanley +Date: Fri Dec 5 03:30:39 2014 +0000 + + Workflow documentation is now in infra-manual + + Replace URLs for workflow documentation to appropriate parts of the + OpenStack Project Infrastructure Manual. + + Change-Id: I5215be3250a2b88a46258d55d5aab611a4091113 + +commit 60c87813da9f2ea056a64f3e8f7eb7b14057b53e +Merge: 21e5b42 acd9067 +Author: Jenkins +Date: Thu Dec 4 18:40:22 2014 +0000 + + Merge "Tighten up documentation" + +commit 21e5b4249bc1a4ef01b693bb9dfa25059393e2dd +Merge: c7e307e 64fe08f +Author: Jenkins +Date: Tue Nov 25 21:08:06 2014 +0000 + + Merge "Add pbr to installation requirements" + +commit c7e307e35917fabd4990894c765d8f08b7da5296 +Author: Sean Dague +Date: Mon Nov 17 08:36:30 2014 -0500 + + provide visual separation in sidebar + + Enhance the sidebar display to provide visual distinction between top + level items and lower level items. Top level items are now given a + space above them so they are visually clumped with their children, and + separated from each other. They are also emboldened for greater visual + distinction. + + Ideally sphinx would actually tag li items with their depth as a class + tag, but as it currently doesn't do that we can work around it with + setting at ul li, and unsetting at ul li ul li. + + Change-Id: I88d4317ec69fe7fd6f5c2198f89de624f0d093da + +commit c8b7c4b344ddd3af7d3caa695a11de883dea2965 +Merge: 6ce23c5 cf85e06 +Author: Jenkins +Date: Thu Nov 13 22:39:44 2014 +0000 + + Merge "Report documentation build warnings as errors" + +commit 6ce23c5983ca552083a6963b8c698bb82ad0d504 +Author: OpenStack Proposal Bot +Date: Sat Oct 11 15:56:21 2014 +0000 + + Updated from global requirements + + Change-Id: Ie3c6bc00b6e3a13cf5f2ac0e68aa25fb8204375d + +commit 64fe08f93121dae6ba1d62aadf734fd8dc53f8cf +Author: Doug Hellmann +Date: Fri Oct 24 09:32:21 2014 -0400 + + Add pbr to installation requirements + + Add pbr to the list of installation requirements so that it is installed + via pip before this library is installed, instead of with easy_install. + This avoids issues like Bug #1384919, and ensures that projects that use + this library as a dependency are properly installed. + + Change-Id: I6c155370dbd01fe4748d5137bdf288e8d3e1a67e + +commit acd90677ef1ac0583cf4fe457236ff6e7d575845 +Author: Doug Hellmann +Date: Tue Oct 21 14:56:34 2014 -0400 + + Tighten up documentation + + Remove some mostly empty pages and add a few section headings. + + Change-Id: I5f0b99ce7573c60b741dd726e55f28cf3bf9f7fc + +commit cf85e067d6b7302555b1b6009e2ac4aa82c0fae5 +Author: Doug Hellmann +Date: Fri Sep 19 11:32:56 2014 -0400 + + Report documentation build warnings as errors + + Change-Id: Ib96d7e0353762e7296292739cd784f8e10d24ce2 + +commit 446a8dc6ca827fe5e9c17f24ea7326338d10d9d6 +Author: Davanum Srinivas +Date: Wed Sep 3 15:51:48 2014 -0400 + + Add initial cut for documentation + + Closes-Bug: #1364141 + + Change-Id: I137d244a50088918e2356da883d09f5d95da8bca + +commit 846487072c5e66b7aea615bd8efdb849409eb1c9 +Author: Julien Danjou +Date: Thu Sep 11 10:37:00 2014 +0200 + + Remove empty file + + It's useless to include it since it's empty. + + Change-Id: I18e147ed2a62671ece9228eb3c6c411bb2aea8f7 + +commit f6fee8b01f20791ce18a090c2b8e23d323ee23be +Author: Doug Hellmann +Date: Wed Sep 3 14:34:48 2014 -0400 + + warn against sorting requirements + + Change-Id: I64ae9191863564e278a35d42ec9cd743a233028e + Addresses-Bug: #1365061 + +commit 98c8c4b8ad297d1fb2269da14ad6ea7009349aeb +Author: Graham Hayes +Date: Mon Jul 7 17:39:24 2014 +0100 + + Fixed link text colour for incubation variant + + When using a link inside the h3.highlighted sidebar element the + text reverts to the default grey colour + + Change-Id: I4e35abd6da42a5d9a7bb8c3b56fd4e8610e4e17c + +commit c144be899391901c34d8ad5a87e457325d8774fb +Author: Graham Hayes +Date: Tue Jul 1 17:10:33 2014 +0100 + + Added a incubating project config option + + This allows projects that are currently incubated to use oslosphinx + + To use a project needs to set + + 'html_theme_options = {'incubating': True}' + + in their sphinx conf.py + + This is option reflected by changing the side bar to have a bar + at the top that shows 'Incubated Project' + + Change-Id: Ib5a06ac1749fec475d326afe19f16fffb8c7d4a7 + +commit b5a3060528d7c014f8d886f11c9de53a41675549 +Author: OpenStack Proposal Bot +Date: Mon Jun 16 09:52:24 2014 +0000 + + Updated from global requirements + + Change-Id: I1588c1e6bbb24999323b8d95b701f01441047c51 + +commit ea4511ebfa66f053947418e7b91f127a4a92624c +Author: Davanum Srinivas +Date: Wed Jun 11 21:57:10 2014 -0400 + + Bump hacking to 0.9.x series + + Change-Id: Iff7562692fe76d24abb16d7b9f283ede2db4357e + +commit 616f90e6855a00d216ce100a4266ddcfc568d8d7 +Author: OpenStack Proposal Bot +Date: Wed Apr 30 02:46:02 2014 +0000 + + Updated from global requirements + + Change-Id: I17f8130c00fd933e5baafb127b41fc8e3fdbafff + +commit 9813d18b43e563a004df1190ac70092ebdc8a531 +Merge: 1933275 195ce9e +Author: Jenkins +Date: Fri Apr 25 11:46:59 2014 +0000 + + Merge "Support building wheels (PEP-427)" + +commit 1933275d31b5d381f687472633a2c9911a69dcad +Merge: b612e98 4b0525f +Author: Jenkins +Date: Mon Apr 14 21:19:14 2014 +0000 + + Merge "Add Python 3 trove classifiers" + +commit b612e989703356ec30ff195187e8de70d29551a6 +Merge: d329312 40d720e +Author: Jenkins +Date: Thu Apr 10 22:03:29 2014 +0000 + + Merge "Prevent left sidebar text overflow" + +commit d32931265aa9cbc3401740119199c61715d2a15c +Author: Vishvananda Ishaya +Date: Tue Mar 18 11:22:06 2014 -0700 + + Update manifest to use oslosphinx + + The recent rename to oslosphinx missed the MANIFEST.in, which + breaks packaging of the non .py files. + + Change-Id: Ib43879697cb855341904500dae3075f7ea5c17c0 + Resolves-bug: 1294272 + +commit 40d720e732a7e4eeb0a33ebca2bb7ac5e6c6f78b +Author: Davanum Srinivas +Date: Fri Mar 7 15:58:32 2014 -0500 + + Prevent left sidebar text overflow + + Add break-word to stop the overflow from the sidebar to the main + content. + + Change-Id: I5b2c60e439462f46eb0b24e5133593d293085c87 + Closes-Bug: #1289548 + +commit 4b0525fd3988210108b48f5750108b525580eaaf +Author: Cyril Roelandt +Date: Mon Mar 10 13:47:46 2014 +0100 + + Add Python 3 trove classifiers + + Change-Id: Ia3633ef89ebc9566e9b91d18b1596b95810c657d + +commit ba83cf44b514f65b85b199697f8668fe47ff1083 +Author: ChangBo Guo(gcb) +Date: Mon Feb 24 04:19:47 2014 -0500 + + Remove vim header + + We don't need vim modelines in each source file, it can be set in + user's vimrc. + + Change-Id: If4f0e93821e20ea837c1fc908845089dd192fcde + Closes-Bug: #1229324 + +commit 28f4cf00a061a96c14ec389f11aa3d919d94d040 +Author: Ben Nemec +Date: Wed Feb 12 16:40:51 2014 +0000 + + Remove references to oslo.sphinx + + There were a few left over in the documentation + + Change-Id: I87ca3e6c104798a94874916df355b6bdc74c1408 + +commit 54062b0b1deeab9e9339378f9450ff495e216b19 +Merge: e7a6344 b31e8f8 +Author: Jenkins +Date: Tue Feb 11 17:04:36 2014 +0000 + + Merge "Sync with global requirements" + +commit e7a6344754f04943acc050872150ab60907b365c +Author: Doug Hellmann +Date: Fri Feb 7 20:42:08 2014 +0000 + + Update .gitreview after repo rename + + Change-Id: I6b6e20a7884b47ade466fc38641a5ac1a5f3e146 + +commit 195ce9e9e24480e7b264af95ea9a8012056126a8 +Author: Sascha Peilicke +Date: Tue Nov 19 09:53:49 2013 +0100 + + Support building wheels (PEP-427) + + Universal is used to identify pure-Python module(by bdist_wheel). For + these, it is sufficient to build a wheel with _any_ Python ABI version + and publish that to PyPI (by whatever means). + + Change-Id: I34b7f390e2ac60d1a35e1bd352d483e0de7a51e1 + +commit 229e16bde97e7b3c7d9c0fd7a4a18c553ce94522 +Author: Doug Hellmann +Date: Thu Feb 6 08:42:54 2014 -0800 + + Rename package from oslo.sphinx to oslosphinx + + Having the sphinx theme in the same namespace package + as the production code has been causing issues with + devstack installations. This change renames the package + to move it out of the namespace. Another change to the + openstack-infra/config repository will rename the + git repository and associated jobs. + + Partial-bug: #1277168 + + Change-Id: I7788a9d6b5984fdfcc4678f2182104d2eb8a2be0 + +commit b31e8f8ca4527e124f9eb15c0a9266a672c6b0bf +Author: Sascha Peilicke +Date: Thu Jan 16 09:16:42 2014 +0100 + + Sync with global requirements + + Change-Id: I6667cf4e868abd4bc63d0d950f7a21c0b5e53f54 + +commit 0fd757d3ed10842a4cd34036a4ab6f983c3f6238 +Merge: 23e6cb4 a530d5e +Author: Jenkins +Date: Mon Dec 30 15:30:38 2013 +0000 + + Merge "Add -U flag to pip install command" + +commit a530d5ed8187fbc613c09fd44584f14c572fe217 +Author: Sergey Lukjanov +Date: Fri Dec 13 20:13:11 2013 +0400 + + Add -U flag to pip install command + + The -U flag makes tox able to upgrade all packages to the newest available + version. + + Change-Id: Ibe5fa0115c2b151ae6f3bd741cc561d2435499e8 + +commit 23e6cb4e11252a04a151b536f15c7a2fc089ec8f +Author: Joe Gordon +Date: Mon Nov 11 10:56:11 2013 -0800 + + Update URL for global HACKING document + + * Related to I579e7c889f3addc2cd40bce0c584bbc70bf435e2 + * Rename local-checks section to make it clearer + + Change-Id: If4e006368c09dcd6c87ebf7a2aba448c9a9390de + +commit 8e152992d4b634e8e346ee6271bf73f579807306 +Merge: d4b06ba 6a71811 +Author: Jenkins +Date: Fri Sep 20 15:27:24 2013 +0000 + + Merge "Update build config" + +commit 6a71811cd733224c7dfb0ed7c5c8f155cfe58976 +Author: Monty Taylor +Date: Thu Sep 19 07:36:45 2013 -0700 + + Update build config + + Use latest pbr things that don't require pbr. Also update the tox config + to ensure venv is updated properly. + + Change-Id: I157127abd129bbe085c64e2a14f67296da0c4b5e + +commit d4b06bab5659926ac8219f750361be4a5158420a +Author: Mark McLoughlin +Date: Wed Sep 18 07:48:56 2013 -0700 + + Add namespace_packages to setup.cfg + + We lost this when switching to latest pbr. + + Thanks to dprince for catching this in Smokestack. + + Change-Id: Ideb3f9750269d825f380351c3bbbbf743bff08ba + +commit c89928aaa02d6f84d2edabda246812f0976e6640 +Author: Monty Taylor +Date: Fri Sep 13 11:33:49 2013 -0500 + + Update pbr usage past needing d2to1 + + Change-Id: Ia5c8dd9259e8098c2ad39eda6fc44c6db81944ad + +commit f296853bedb92c3faded41790a05c203f41e9732 +Author: Julien Danjou +Date: Thu Jul 25 16:09:18 2013 +0200 + + Remove useless jquery.tweet.js + + This file exports a jQuery tweet function, but it's never called anywhere in + the theme. + + Change-Id: Ie5191940a8e9dc3e2562888d050cd00dc63066d8 + +commit 9f34799a2c9880fce18d3f89033caa968cfd7ad1 +Author: Sergey Lukjanov +Date: Sat Jul 20 00:48:36 2013 +0400 + + Allow use of hacking 0.6.0 and fix min version + + Change-Id: If336be59cf790029b5e24f05074e6ec6e9658134 + +commit e4b2587d6b7ae2faa8cb9da7039a82705fbb3067 +Author: Monty Taylor +Date: Fri Jul 5 11:06:22 2013 -0400 + + Add an OpenStack-wide intersphinx mapping file + + Change-Id: Id30470132eb9540b6f7fb693fca5ec0cbe2ce49a + +commit 9ab5dacf3efbf5c3900176484082edf2623ed638 +Merge: f93071e b139fa8 +Author: Jenkins +Date: Fri Jul 12 22:45:30 2013 +0000 + + Merge "Ensure that AUTHORS and ChangeLog are packaged" + +commit b139fa873e35fb4e60333f25b6e548d4a355becc +Author: Dirk Mueller +Date: Mon Jul 8 11:04:55 2013 +0200 + + Ensure that AUTHORS and ChangeLog are packaged + + Include AUTHORS and ChangeLog from pbr to be included + in the sdist tarball. Add a minimal HACKING.rst for + consistency with other projects. + + Fixes LP Bug #1186518 + + Change-Id: I0f188c1c1b449b74b43296222d33a89f98645950 + +commit f93071eef0039a570f887bbd2c46324ce75873ce +Author: Monty Taylor +Date: Fri Jul 5 11:15:52 2013 -0400 + + Add emacs save files to gitignore + + Change-Id: If0accbcc80d9289907d83a9df0e0d0604c11800b + +commit 4e2051a422307ee1a9c28cc221fa3ff82d025c0d +Author: Monty Taylor +Date: Fri Jul 5 13:04:22 2013 -0400 + + Add venv tox env. + + OpenStack CI requires this to generate the tarball. + + Change-Id: I170f4d25e4a59027d4c85ff70f03f31a1b3dc916 + +commit ac91ff16bc7e0ec7bd9157cef04aae5f5518663a +Author: Doug Hellmann +Date: Mon Jul 1 17:32:22 2013 -0400 + + Import Sphinx theme for OpenStack + + This is a copy of the Sphinx theme for OpenStack developer + documentation imported from the ceilometer repository. After + this library is released, we will remove the copies of the + theme from all of the other repositories. + + blueprint oslo.sphinx + + Change-Id: I20b6c224b8d8fbede354c2a28ad67eda3a4b9dac + Signed-off-by: Doug Hellmann + +commit eca47086d010f519bf7fb32e9c56c79e13c255c9 +Author: OpenStack Project Creator +Date: Sun Jun 30 17:07:29 2013 +0000 + + Added .gitreview diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000000000000000000000000000000000000..e770d0247525f20e2d844f161ba5660623fed47c --- /dev/null +++ b/debian/changelog @@ -0,0 +1,232 @@ +oslo-sphinx (4.18.0-6) UNRELEASED; urgency=medium + + * Update watch file format version to 4. + * Bump debhelper from old 10 to 13. + + Replace python_distutils buildsystem with pybuild. + + -- Debian Janitor Mon, 06 Sep 2021 12:25:26 -0000 + +oslo-sphinx (4.18.0-5) unstable; urgency=medium + + [ Ondřej Nový ] + * Run wrap-and-sort -bastk. + + [ Michal Arbet ] + * d/patches: Add sphinx-2.4-compatibility.patch + * d/copyright: Add me + * d/control: Add me to uploaders field + + -- Michal Arbet Fri, 24 Apr 2020 17:16:39 +0200 + +oslo-sphinx (4.18.0-4) unstable; urgency=medium + + * Removed Testsuite: autopkgtest-pkg-python (Closes: #940974). + + -- Thomas Goirand Tue, 24 Sep 2019 11:47:43 +0200 + +oslo-sphinx (4.18.0-3) unstable; urgency=medium + + [ Ondřej Nový ] + * d/control: Set Vcs-* to salsa.debian.org + * d/control: Add trailing tilde to min version depend to allow + backports + * d/control: Use team+openstack@tracker.debian.org as maintainer + * Use debhelper-compat instead of debian/compat. + + [ Thomas Goirand ] + * Drop python 2 support (Closes: #937219). + + -- Thomas Goirand Wed, 04 Sep 2019 09:51:49 +0200 + +oslo-sphinx (4.18.0-2) unstable; urgency=medium + + * Uploading to unstable. + + -- Thomas Goirand Sun, 25 Feb 2018 20:56:01 +0000 + +oslo-sphinx (4.18.0-1) experimental; urgency=medium + + [ Daniel Baumann ] + * Updating vcs fields. + * Updating copyright format url. + * Running wrap-and-sort -bast. + * Updating maintainer field. + * Updating standards version to 4.0.0. + * Removing gbp.conf, not used anymore or should be specified in the + developers dotfiles. + * Updating standards version to 4.0.1. + * Updating standards version to 4.1.0. + + [ Thomas Goirand ] + * New upstream release. + * Fixed (build-)depends for this release. + * Standards-Version is now 4.1.3. + * Removed fixed_attribute_error.patch applied upstream. + + -- Thomas Goirand Sun, 11 Feb 2018 13:37:48 +0000 + +oslo-sphinx (4.7.0-2) unstable; urgency=medium + + [ Ondřej Nový ] + * d/s/options: extend-diff-ignore of .gitreview + * d/control: Using OpenStack's Gerrit as VCS URLs. + + [ Thomas Goirand ] + * Uploading to unstable. + * Package missing files (ie: all from oslosphinx/theme was missing). + + -- Thomas Goirand Sat, 01 Oct 2016 21:16:35 +0200 + +oslo-sphinx (4.7.0-1) experimental; urgency=medium + + * Team upload. + * New upstream release + * Rebased d/p/fixed_attribute_error.patch + + -- Ondřej Nový Fri, 05 Aug 2016 22:40:53 +0200 + +oslo-sphinx (4.6.0-1) experimental; urgency=medium + + * Team upload. + * New upstream release + * Rebased d/p/move_theme.patch + * Added d/p/fixed_attribute_error.patch + + -- Ondřej Nový Mon, 18 Jul 2016 21:24:29 +0200 + +oslo-sphinx (4.4.0-1) experimental; urgency=medium + + * Team upload + + [ Corey Bryant ] + * New upstream release. + * d/gbp.conf: Update branch for Newton. + * d/control: Align (Build-)Depends with upstream. + + [ Ondřej Nový ] + * Added Python3 version + * Moved theme to python-oslosphinx-common package + * Bumped openstack-pkg-tools required version to 51 + * Enabled autopkgtest-pkg-python testsuite + * Use extend-diff-ignore to ignore egg-info + * Rebased d/p/remove-google-analytics.patch + + -- Ondřej Nový Sat, 16 Jul 2016 15:50:43 +0200 + +oslo-sphinx (4.3.0-1) unstable; urgency=medium + + * Team upload. + + [ David Della Vecchia ] + * New upstream release (Closes: #820682). + * d/control: Align depends with upstream. + * d/p/fix-exception-in-checking-git-remote-url.patch: Removed, + fixed upstream. + + [ Ondřej Nový ] + * Fixed VCS URLs (https). + * Added simple Debian test. + * d/copyright + - Rearranged order of d/copyright. + - Added myself of Debian part. + * Standards-Version is 3.9.8 now (no change). + * Changed upstream git URL to https schema. + + -- Ondřej Nový Fri, 29 Apr 2016 12:21:43 +0200 + +oslo-sphinx (4.0.0-2) unstable; urgency=medium + + * Uploading to unstable. + * Adding myself to uploaders list. + + -- Ivan Udovichenko Mon, 04 Apr 2016 11:05:25 +0300 + +oslo-sphinx (4.0.0-1) experimental; urgency=medium + + [ Corey Bryant ] + * New upstream release. + * d/control: Align dependencies with upstream. + * d/gbp.conf: Update debian-branch to debian/liberty. + * d/control: Update uploaders. + + [ Thomas Goirand ] + * Add patch to remove google-analytics.com javascript. + + -- Thomas Goirand Thu, 26 Nov 2015 15:02:24 +0100 + +oslo-sphinx (2.5.0-1) unstable; urgency=medium + + * New upstream release. + * Added python-pbr and python-requests as new Depends. + * Uploading to unstable. + * Drops python-oslo.sphinx transition package after the release of Jessie. + * Standards-Version: 3.9.6. + + -- Thomas Goirand Wed, 25 Feb 2015 10:20:53 +0100 + +oslo-sphinx (2.2.0.0-1) experimental; urgency=medium + + * New upstream release. + + -- Thomas Goirand Wed, 24 Sep 2014 09:47:25 +0800 + +oslo-sphinx (2.2.0.0~a3-1) experimental; urgency=medium + + * New upstream release. + * Uploading to experimental before the freeze of Jessie. + + -- Thomas Goirand Fri, 05 Sep 2014 15:06:42 +0800 + +oslo-sphinx (2.1.0-1) unstable; urgency=medium + + [ Thomas Goirand ] + * Uploading to unstable. + + [ gustavo panizzo ] + * New upstream release. + + -- Thomas Goirand Fri, 18 Apr 2014 10:33:19 +0800 + +oslo-sphinx (2.0-3) experimental; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license (this was previously fixed in Sid). + + -- Thomas Goirand Fri, 21 Mar 2014 05:56:11 +0000 + +oslo-sphinx (2.0-2) experimental; urgency=medium + + * Packages the oslosphinx/theme folder correctly. + + -- Thomas Goirand Sun, 09 Mar 2014 14:09:12 +0800 + +oslo-sphinx (2.0-1) experimental; urgency=medium + + * New upstream release. + * Standards-Version: is now 3.9.5. + * Upstream renamed oslo.sphinx into oslosphinx, transitionning + accordingly (and adding a new package). + * Removed oslo/sphinx/theme/openstack/static/jquery.tweet.js from + debian/copyright, because the file is gone upstream. + + -- Thomas Goirand Wed, 05 Mar 2014 15:54:09 +0800 + +oslo-sphinx (1.0-3) unstable; urgency=medium + + * Fixed license of oslo/sphinx/theme/openstack/static/nature.css which is + under a BSD-2-clause license. (Closes: #740932). + * Standards-Version: is now 3.9.5. + + -- Thomas Goirand Fri, 21 Mar 2014 05:49:08 +0000 + +oslo-sphinx (1.0-2) unstable; urgency=low + + * Cleans correctly (package can be built twice). + + -- Thomas Goirand Thu, 25 Jul 2013 19:24:07 +0800 + +oslo-sphinx (1.0-1) unstable; urgency=low + + * Initial release (Closes: #717809). + + -- Thomas Goirand Thu, 25 Jul 2013 17:57:32 +0800 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000000000000000000000000000000000000..b7cb74796bf3b8cd447c943d51f175995d3e57d7 --- /dev/null +++ b/debian/control @@ -0,0 +1,55 @@ +Source: oslo-sphinx +Section: python +Priority: optional +Maintainer: Debian OpenStack +Uploaders: + Thomas Goirand , + Michal Arbet , + Corey Bryant , + Ivan Udovichenko , + David Della Vecchia , +Build-Depends: + debhelper-compat (= 13), + dh-python, + openstack-pkg-tools (>= 99~), + python3-all, + python3-pbr, + python3-setuptools, + python3-sphinx, +Build-Depends-Indep: + python3-hacking (>= 0.10.0), + python3-openstackdocstheme, + python3-requests (>= 2.14.2), + python3-six, +Standards-Version: 4.1.3 +Vcs-Browser: https://salsa.debian.org/openstack-team/oslo/oslo-sphinx +Vcs-Git: https://salsa.debian.org/openstack-team/oslo/oslo-sphinx.git +Homepage: https://github.com/openstack/oslo.sphinx + +Package: python-oslosphinx-common +Architecture: all +Depends: + ${misc:Depends}, + ${python3:Depends}, +Description: theme and extension support for openstack - common + Theme and extension support for Sphinx documentation from the OpenStack + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + . + This package contains the common files. + +Package: python3-oslosphinx +Architecture: all +Depends: + python-oslosphinx-common, + python3-pbr, + python3-requests, + python3-six, + ${misc:Depends}, + ${python3:Depends}, +Description: theme and extension support for openstack - Python 3.x + Theme and extension support for Sphinx documentation from the OpenStack + project. To use the theme, symply add 'oslosphinx' to the extensions list in + the conf.py file in your Sphinx project. + . + This package contains the Python 3.x module. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000000000000000000000000000000000000..491dcfb294943c880ed73c2e54e74bea4d16cdf0 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,62 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: oslo.sphinx +Source: https://github.com/openstack/oslo.sphinx.git + +Files: * +Copyright: (c) 2013, Monty Taylor + (c) 2013, Doug Hellmann + (c) 2007-2011, by the Sphinx team + (c) 2013, New Dream Network, LLC (DreamHost) + (c) 2013, Hewlett-Packard Development Company, L.P. +License: Apache-2.0 + +Files: debian/* +Copyright: (c) 2013, Thomas Goirand + (c) 2016, Ondřej Nový + (c) 2020, Michal Arbet +License: Apache-2.0 + +Files: oslosphinx/theme/openstack/static/nature.css +Copyright: (c) 2007-2011 the Sphinx team +License: BSD-2-clause + +License: Apache-2.0 + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + . + http://www.apache.org/licenses/LICENSE-2.0 + . + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + . + On Debian-based systems the full text of the Apache version 2.0 license + can be found in `/usr/share/common-licenses/Apache-2.0'. + +License: BSD-2-clause + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are met: + . + Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + . + Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. Neither the name of + the University of California, Berkeley nor the names of its contributors may + be used to endorse or promote products derived from this software without + specific prior written permission. + . + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/debian/patches/move_theme.patch b/debian/patches/move_theme.patch new file mode 100644 index 0000000000000000000000000000000000000000..9173139051850852863b785a5fcdec421e1d99f3 --- /dev/null +++ b/debian/patches/move_theme.patch @@ -0,0 +1,18 @@ +Description: Move theme to /usr/share +Author: Ondřej Nový +Forwarded: not-needed +Last-Update: 2016-07-16 + +Index: oslo-sphinx/oslosphinx/__init__.py +=================================================================== +--- oslo-sphinx.orig/oslosphinx/__init__.py ++++ oslo-sphinx/oslosphinx/__init__.py +@@ -72,7 +72,7 @@ def _get_other_versions(app): + + + def builder_inited(app): +- theme_dir = os.path.join(os.path.dirname(__file__), 'theme') ++ theme_dir = os.path.join(os.sep, 'usr', 'share', 'oslosphinx') + app.info('Using openstack theme from %s' % theme_dir) + # Insert our theme directory at the front of the search path and + # force the theme setting to use the one in the package unless diff --git a/debian/patches/package-missing-files.patch b/debian/patches/package-missing-files.patch new file mode 100644 index 0000000000000000000000000000000000000000..13b1cabf7e0f0ccbdfae5575a74ac3ece703d7e7 --- /dev/null +++ b/debian/patches/package-missing-files.patch @@ -0,0 +1,9 @@ +Description: The theme static files aren't packaged by PBR +Author: Thomas Goirand +Forwarded: not-needed +Last-Update: 2016-09-01 + +--- /dev/null 2016-09-01 16:08:01.266394396 +0200 ++++ b/MANIFEST.in 2016-10-01 21:17:41.966600255 +0200 +@@ -0,0 +1 @@ ++recursive-include oslosphinx * diff --git a/debian/patches/remove-google-analytics.patch b/debian/patches/remove-google-analytics.patch new file mode 100644 index 0000000000000000000000000000000000000000..f359f450c0c92d8c0af270d22d4650938c18c325 --- /dev/null +++ b/debian/patches/remove-google-analytics.patch @@ -0,0 +1,20 @@ +Description: Removes Google Analytics JS +Author: Thomas Goirand +Forwarded: https://review.openstack.org/#/c/250389/ +Last-Update: 2015-11-26 + +Index: oslo-sphinx/oslosphinx/theme/openstack/layout.html +=================================================================== +--- oslo-sphinx.orig/oslosphinx/theme/openstack/layout.html ++++ oslo-sphinx/oslosphinx/theme/openstack/layout.html +@@ -107,10 +107,6 @@ + {% block footer %} + {{ super() }} + +- + +{% endblock %} diff --git a/oslosphinx/theme/openstack/static/basic.css b/oslosphinx/theme/openstack/static/basic.css index cc289c87b0d6cafdc73b65d8b422504908889d03..5542eea1ceae6e64584c493ce233f18d8f5df7c4 100644 --- a/oslosphinx/theme/openstack/static/basic.css +++ b/oslosphinx/theme/openstack/static/basic.css @@ -12,7 +12,6 @@ div.clearer { /* -- relbar ---------------------------------------------------------------- */ div.related { - width: 100%; font-size: 90%; } @@ -43,7 +42,7 @@ div.sphinxsidebarwrapper { div.sphinxsidebar { float: left; - width: 230px; + width: 260px; margin-left: -100%; font-size: 90%; } diff --git a/oslosphinx/theme/openstack/static/nature.css b/oslosphinx/theme/openstack/static/nature.css index 060ced88ca8c4c97cce784a39c57f586f1f11bd8..aa8099530aec7d28bc8c76dea1799076c8ca89a0 100644 --- a/oslosphinx/theme/openstack/static/nature.css +++ b/oslosphinx/theme/openstack/static/nature.css @@ -188,8 +188,8 @@ div.highlight{ } div.note { - background-color: #eee; - border: 1px solid #ccc; + background-color: #edf2f7; + border: 1px solid #2a4e68; } div.seealso { @@ -206,6 +206,21 @@ div.warning { border: 1px solid #f66; } +div.important { + background-color: #feffbe; + border: 1px solid #d7aa16; +} + +div.caution { + background-color: #eee; + border: 1px solid #ccc; +} + +div.tip { + background-color: #eee; + border: 1px solid #ccc; +} + p.admonition-title { display: inline; } diff --git a/oslosphinx/theme/openstack/static/tweaks.css b/oslosphinx/theme/openstack/static/tweaks.css index 6d3bea3e072e53105c35a41a383a8bd881a17766..5bd5ff2aeff2b21c571e6ce115ddf257d8f7857a 100644 --- a/oslosphinx/theme/openstack/static/tweaks.css +++ b/oslosphinx/theme/openstack/static/tweaks.css @@ -85,7 +85,7 @@ a.headerlink { div.body { margin-top: -25px; - margin-left: 230px; + margin-left: 260px; } div.document { @@ -101,4 +101,28 @@ div.sphinxsidebar h3.highlighted { div.sphinxsidebar h3.highlighted a { color: #EEE; +} + +/** provide visual separation for sidebar for increased readability. */ +div.sphinxsidebar ul li { + margin-top: 1em; + font-weight: bold; +} + +div.sphinxsidebar ul li ul li { + margin-top: 0; + font-weight: normal; +} + +/** Provide the sidebar to allow long words to go to the next line + making them easier to read.*/ +div.sphinxsidebar a { + display: block; + text-indent: -1em; + margin-left: 1em; + word-wrap: break-word; +} + +div.sphinxsidebar ul { + margin: 10px 10px; } \ No newline at end of file diff --git a/oslosphinx/theme/openstack/theme.conf b/oslosphinx/theme/openstack/theme.conf index e2b8bfe68d8545d76697cf6f314ab5f387398ad0..2d5cc2915985ef94c896ef608881260721735dbc 100644 --- a/oslosphinx/theme/openstack/theme.conf +++ b/oslosphinx/theme/openstack/theme.conf @@ -5,3 +5,4 @@ pygments_style = tango [options] incubating = false +show_other_versions = false diff --git a/releasenotes/notes/add-reno-996dd44974d53238.yaml b/releasenotes/notes/add-reno-996dd44974d53238.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2234c38f57f219f32801c4515ec75cdb7cf13511 --- /dev/null +++ b/releasenotes/notes/add-reno-996dd44974d53238.yaml @@ -0,0 +1,3 @@ +--- +other: + - Introduce reno for deployer release notes. diff --git a/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml b/releasenotes/notes/obsolete-3da30e6cd2867d0e.yaml new file mode 100644 index 0000000000000000000000000000000000000000..70f44615197dfcd919331021f0a3c5a97c24a82a --- /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. diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..e5e414f37c02c39492e541b84229059384312bd0 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,277 @@ +# -*- coding: utf-8 -*- +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +# Add any paths that contain templates here, relative to this directory. +#templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'oslosphinx Release Notes' +copyright = u'2016, oslosphinx Developers' + +# Release notes do not need a version in the title, they span +# multiple versions. +# The full version, including alpha/beta/rc tags. +release = '' +# The short X.Y version. +version = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'openstackdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'oslosphinxReleaseNotesDoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'oslosphinxReleaseNotes.tex', + u'oslosphinx Release Notes Documentation', + u'oslosphinx Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'oslosphinxReleaseNotes', + u'oslosphinx Release Notes Documentation', + [u'oslosphinx Developers'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'oslosphinxReleaseNotes', + u'oslosphinx Release Notes Documentation', + u'oslosphinx Developers', 'oslosphinxReleaseNotes', + 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- +repository_name = 'openstack/oslosphinx' +bug_project = 'oslosphinx' +bug_tag = '' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..580a41ec376515e6af03a1acba7cad1d0e12319a --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,10 @@ +========================== + oslosphinx Release Notes +========================== + + .. toctree:: + :maxdepth: 1 + + unreleased + pike + ocata diff --git a/releasenotes/source/ocata.rst b/releasenotes/source/ocata.rst new file mode 100644 index 0000000000000000000000000000000000000000..ebe62f42e1793ff713b1eca98e4453306b911cdd --- /dev/null +++ b/releasenotes/source/ocata.rst @@ -0,0 +1,6 @@ +=================================== + Ocata Series Release Notes +=================================== + +.. release-notes:: + :branch: origin/stable/ocata diff --git a/releasenotes/source/pike.rst b/releasenotes/source/pike.rst new file mode 100644 index 0000000000000000000000000000000000000000..e43bfc0ce198dc0834a2835faa9338009de1542a --- /dev/null +++ b/releasenotes/source/pike.rst @@ -0,0 +1,6 @@ +=================================== + Pike Series Release Notes +=================================== + +.. release-notes:: + :branch: stable/pike diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd22aabcccdafb09197c7a37faef4b740ac385b0 --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: diff --git a/requirements.txt b/requirements.txt index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..ad13f8c9b17b42656b9435ac1a8465c2267ecf01 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +pbr!=2.1.0,>=2.0.0 # Apache-2.0 +requests>=2.14.2 # Apache-2.0 +six>=1.10.0 # MIT diff --git a/setup.cfg b/setup.cfg index b65ee52f81f2694c8afb21767ae9c0401d763933..594e216e1ef0502d424ec54e4d2fba0b27ab6466 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://www.openstack.org/ +home-page = http://docs.openstack.org/developer/oslosphinx classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -14,10 +14,9 @@ classifier = Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 2 - Programming Language :: Python :: 2.6 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 - Programming Language :: Python :: 3.3 + Programming Language :: Python :: 3.5 Topic :: Documentation [global] @@ -32,6 +31,7 @@ packages = all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [wheel] universal = 1 diff --git a/setup.py b/setup.py old mode 100755 new mode 100644 index 736375744d94f6f122f98fab48b8fc77b13d8bec..566d84432eeda2c367f881c596d327a703beb79a --- a/setup.py +++ b/setup.py @@ -1,4 +1,3 @@ -#!/usr/bin/env python # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,5 +25,5 @@ except ImportError: pass setuptools.setup( - setup_requires=['pbr'], + setup_requires=['pbr>=2.0.0'], pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt index c0de34d0a5eb10f9f4b8fcf8a31a789357ab6336..d9d4239f9db2a1e8ec3de94b96a0475b0ba858d5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1 +1,10 @@ -hacking>=0.9.2,<0.10 +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 + +# this is required for the docs build jobs +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.17.0 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index e7a71d7b98d4c8cea4d81f624c481aa9950c777d..ae632a1fd61e1fbbb71dd481c972d304462928df 100644 --- a/tox.ini +++ b/tox.ini @@ -1,16 +1,13 @@ [tox] -minversion = 1.6 -skipsdist = True +minversion = 2.0 envlist = pep8 [testenv] -usedevelop = True -install_command = pip install -U {opts} {packages} -deps = -r{toxinidir}/requirements.txt - -r{toxinidir}/test-requirements.txt -setenv = VIRTUAL_ENV={envdir} -sitepackages = False -downloadcache = {toxworkdir}/_download +install_command = pip install {opts} {packages} +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/test-requirements.txt + -r{toxinidir}/requirements.txt [testenv:pep8] commands = @@ -19,6 +16,12 @@ commands = [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools show-source = True + +[testenv:releasenotes] +commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html