Set up the doc infra and add doc job

devstack-plugins-nfs does not have the doc infra set
up and no doc publish job.

This is need to add the contributor doc as per the ussuri
community goal.

Change-Id: Ie091ebd4dc35ef429d60c41d74a9344b3f083718

.gitignore

@@ -0,0 +1,7 @@
+*~
+.*.sw?
+.prereqs
+.tox
+build
+doc/build
+ChangeLog

.zuul.yaml

@@ -1,4 +1,6 @@
 - project:
+    templates:
+      - publish-openstack-docs-pti
     check:
       jobs:
         - devstack-plugin-nfs-tempest-full
@@ -33,7 +35,9 @@
         ENABLE_NFS_CINDER: true
         # enabled by default in tempest-full:
         ENABLE_VOLUME_MULTIATTACH: false
-    irrelevant-files:
+    irrelevant-files: &gate-irrelevant-files
+      - ^.*\.rst$
+      - ^doc/.*$
       - ^(test-|)requirements.txt$
       - ^setup.cfg$
     branches:
@@ -63,9 +67,7 @@
         ENABLE_NFS_CINDER: true
         # enabled by default in tempest-full:
         ENABLE_VOLUME_MULTIATTACH: false
-    irrelevant-files:
+    irrelevant-files: *gate-irrelevant-files
-      - ^(test-|)requirements.txt$
-      - ^setup.cfg$
     branches: ^(?!stable/(ocata|pike|queens|rocky|stein|train)).*$
 
 - job:

README.md

@@ -1,3 +1,6 @@
+Devstack NFS Plugin
+===================
+
 To use:
 
 enable_plugin devstack-plugin-nfs http://url_to/this_plugin/nfs

doc/requirements.txt

@@ -0,0 +1,5 @@
+# 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.
+openstackdocstheme>=1.18.1 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,>=1.6.2  # BSD

doc/source/conf.py

@@ -0,0 +1,79 @@
+# -*- 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    #'sphinx.ext.intersphinx',
+    'openstackdocstheme'
+]
+
+# openstackdocstheme options
+repository_name = 'openstack/devstack-plugin-nfs'
+bug_project = 'devstack-plugin-nfs'
+bug_tag = ''
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Devstack Plugin NFS'
+copyright = u'2013, OpenStack Foundation'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'openstackdocs'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'OpenStack Foundation', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/index.rst

@@ -0,0 +1,13 @@
+================================================
+Welcome to Devstack Plugin NFS's documentation!
+================================================
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+
+Indices and tables
+------------------
+
+* :ref:`search`

doc/source/readme.rst

@@ -0,0 +1 @@
+.. include:: ../../README.md

tox.ini

@@ -23,3 +23,12 @@ commands = bash -c "find {toxinidir}          \
           -wholename \*/lib/\*                \
          \)                                   \
          -print0 | xargs -0 bashate -v"
+
+[testenv:docs]
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/doc/requirements.txt
+commands =
+  rm -rf doc/build
+  sphinx-build -W -b html doc/source doc/build/html
+whitelist_externals = rm