diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index dc240b3e..ec44b6e9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,17 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - https://docs.openstack.org/infra/manual/developers.html + https://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://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/ovsdbapp + https://bugs.launchpad.net/ovsdbapp diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..383055c0 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=1.20.0 # Apache-2.0 + +# releasenotes +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index c1038701..ad6f7dab 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -63,8 +63,6 @@ pygments_style = 'sphinx' # html_static_path = ['static'] html_theme = 'openstackdocs' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index bd6646b5..43fb41e3 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -12,9 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Glance Release Notes documentation build configuration file, created by -# sphinx-quickstart on Tue Nov 3 17:40:50 2015. -# # This file is execfile()d with the current directory set to its # containing dir. # @@ -145,7 +142,7 @@ html_theme = 'openstackdocs' # 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'] +# 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 @@ -154,7 +151,7 @@ html_static_path = ['_static'] # 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' +# html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -194,7 +191,7 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'GlanceReleaseNotesdoc' +htmlhelp_basename = 'ovsdbappReleaseNotesdoc' # -- Options for LaTeX output --------------------------------------------- @@ -214,8 +211,8 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation', - u'Glance Developers', 'manual'), + ('index', 'ovsdbappNotes.tex', u'ovsdbapp Release Notes Documentation', + u'ovsdbapp Developers', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -239,42 +236,5 @@ latex_documents = [ # 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', 'glancereleasenotes', u'Glance Release Notes Documentation', - [u'Glance 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', 'GlanceReleaseNotes', u'Glance Release Notes Documentation', - u'Glance Developers', 'GlanceReleaseNotes', - '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/'] diff --git a/setup.cfg b/setup.cfg index 9e02dd79..c1ad6363 100644 --- a/setup.cfg +++ b/setup.cfg @@ -23,15 +23,6 @@ classifier = packages = ovsdbapp -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = ovsdbapp/locale domain = ovsdbapp @@ -45,8 +36,3 @@ input_file = ovsdbapp/locale/ovsdbapp.pot keywords = _ gettext ngettext l_ lazy_gettext mapping_file = babel.cfg output_file = ovsdbapp/locale/ovsdbapp.pot - -[build_releasenotes] -all_files = 1 -build-dir = releasenotes/build -source-dir = releasenotes/source diff --git a/test-requirements.txt b/test-requirements.txt index 2e215ddd..7e2e7ed4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,15 +6,9 @@ hacking<0.13,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 pylint==1.9.2 # GPLv2 stestr>=2.0.0 # Apache-2.0 testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT - -# releasenotes -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index bd94bda5..ea07307f 100644 --- a/tox.ini +++ b/tox.ini @@ -31,10 +31,15 @@ commands = python setup.py test --coverage --testr-args='{posargs}' [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +deps = + -r{toxinidir}/doc/requirements.txt +commands = + sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html [testenv:releasenotes] basepython = python3 +deps = + -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html diff --git a/zuul.d/project.yaml b/zuul.d/project.yaml index 1030c872..aef8fb63 100644 --- a/zuul.d/project.yaml +++ b/zuul.d/project.yaml @@ -1,17 +1,17 @@ - project: templates: + - check-requirements + - openstack-lower-constraints-jobs - openstack-python-jobs - openstack-python3-train-jobs - - check-requirements + - publish-openstack-docs-pti check: jobs: - - openstack-tox-lower-constraints - openstack-tox-functional - openstack-tox-functional-py36 - ovsdbapp-tempest-dsvm-networking-ovn-ovs-release gate: jobs: - - openstack-tox-lower-constraints - openstack-tox-functional - openstack-tox-functional-py36 - ovsdbapp-tempest-dsvm-networking-ovn-ovs-release