feat: Add doc base frame

Add doc base frame

Change-Id: Ie641923b3da8b07f6f430c00bee2736690df6f64

.gitignore

@@ -19,6 +19,8 @@ skyline_console.egg-info/
 AUTHORS
 ChangeLog
 RELEASENOTES.rst
+doc/build
+doc/source/_static
 
 # config
 test/e2e/config/local_config.yaml

.zuul.yaml

@@ -540,6 +540,9 @@
       release_python: python3
 
 - project:
+    templates:
+      - release-notes-jobs-python3
+      - publish-openstack-docs-pti
     check:
       jobs:
         - skyline-nodejs14-run-lint-src

doc/README.rst

@@ -0,0 +1,33 @@
+================================
+Skyline Console Development Docs
+================================
+
+Files under this directory tree are used for generating the documentation
+for the skyline-console source code.
+
+Developer documentation is built to:
+https://docs.openstack.org/skyline-console/latest/
+
+Tools
+=====
+
+Sphinx
+  The Python Sphinx package is used to generate the documentation output.
+  Information on Sphinx, including formatting information for RST source
+  files, can be found in the `Sphinx online documentation
+  <http://www.sphinx-doc.org/en/stable/>`_.
+
+Graphviz
+  Some of the diagrams are generated using the ``dot`` language
+  from Graphviz. See the `Graphviz documentation <http://www.graphviz.org/>`_
+  for Graphviz and dot language usage information.
+
+
+Building Documentation
+======================
+
+Doc builds are performed using tox with the ``docs`` target::
+
+ % cd ..
+ % tox -e docs
+

doc/requirements.txt

@@ -0,0 +1,12 @@
+# 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>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+doc8>=0.6.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+os-api-ref>=1.4.0 # Apache-2.0
+ddt>=1.0.1 # MIT
+fixtures>=3.0.0 # Apache-2.0/BSD
+oslotest>=3.2.0 # Apache-2.0

doc/source/admin/index.rst

@@ -0,0 +1,6 @@
+====================
+Administration Guide
+====================
+
+.. toctree::
+   :maxdepth: 1

doc/source/conf.py

@@ -0,0 +1,318 @@
+# 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.
+#
+# Skyline Console documentation build configuration file, created by
+# sphinx-quickstart on Thu Aug 1 14:22:36 2022.
+#
+# 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.
+
+import os
+import sys
+
+# 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('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+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 = ['sphinx.ext.autodoc',
+              'sphinx.ext.coverage',
+              'sphinx.ext.ifconfig',
+              'sphinx.ext.graphviz',
+              'openstackdocstheme',
+              ]
+
+# openstackdocstheme options
+openstackdocs_repo_name = 'openstack/skyline-console'
+openstackdocs_bug_project = 'skyline-apiserver'
+openstackdocs_bug_tag = 'docs'
+openstackdocs_pdf_link = True
+
+# Set aliases for extlinks
+# - bug - [:bug:`12345`]
+# - blueprint - [:blueprint:`xxx-yyy`]
+extlinks = {
+    'opendev-repo': (
+        'https://opendev.org/%s',
+        '',
+    ),
+    'launchpad': (
+        'https://bugs.launchpad.net/%s',
+        'launchpad ',
+    ),
+}
+
+# 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.
+copyright = '2022, Skyline Console developers'
+
+# 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 = 'native'
+
+# A list of ignored prefixes for module index sorting.
+modindex_common_prefix = ['skyline_console.']
+
+primary_domain = 'py'
+nitpicky = 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_path = ['.']
+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 = {
+    "show_other_versions": "True"
+}
+
+# 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
+# "<project> v<release> 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 = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# 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 <link> 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 = 'SkylineConsoledoc'
+
+# -- Options for LaTeX output -------------------------------------------------
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index', 'SkylineConsoledoc.tex', u'Skyline Console Developer Documentation',
+     u'Skyline Console contributors', '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 = False
+
+latex_elements = {
+    'makeindex': '',
+    'printindex': '',
+    'preamble': r'\setcounter{tocdepth}{3}',
+}
+
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
+latex_use_xindy = False
+
+# -- Options for manual page output -------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'skyline_console', 'Skyline Console Documentation',
+     ['OpenStack'], 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', 'Skyline Console', 'Skyline Console Documentation', 'OpenStack',
+     'Skyline Console', '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'
+
+
+# -- Options for Epub output --------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = 'Skyline Console'
+epub_author = 'OpenStack'
+epub_publisher = 'OpenStack'
+epub_copyright = '2022, Skyline Console developers'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+# epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+# epub_scheme = ''
+
+# The unique identifier of the text. This can be an ISBN number
+# or the project homepage.
+# epub_identifier = ''
+
+# A unique identification for the text.
+# epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+# epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+# epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+# epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+# epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+# epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+# epub_tocdup = True

doc/source/configuration/index.rst

@@ -0,0 +1,6 @@
+===================
+Configuration Guide
+===================
+
+.. toctree::
+   :maxdepth: 1

doc/source/contributor/index.rst

@@ -0,0 +1,6 @@
+===========================
+ Contributor Documentation
+===========================
+
+.. toctree::
+   :maxdepth: 1

doc/source/glossary.rst

@@ -0,0 +1,5 @@
+.. _glossary:
+
+========
+Glossary
+========

doc/source/index.rst

@@ -0,0 +1,62 @@
+..
+      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.
+
+==================================================
+Skyline Console (UI of OpenStack Modern Dashboard)
+==================================================
+
+Introduction
+============
+
+`Skyline Console <https://github.com/openstack/skyline-console>`_ is one part
+of OpenStack Modern Dashboard, which provides a web based user interface to
+OpenStack services including Nova, Swift, Keystone, etc.
+
+Using Skyline Console
+=====================
+
+How to use Skyline Console in your own projects.
+
+.. toctree::
+   :maxdepth: 2
+
+   install/index
+   configuration/index
+   User Documentation <user/index>
+   admin/index
+
+Contributor Docs
+================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributor/index
+
+Release Notes
+=============
+
+See https://docs.openstack.org/releasenotes/skyline-console
+
+Information
+===========
+
+.. toctree::
+   :maxdepth: 1
+
+   glossary
+
+.. only:: html
+
+   * :ref:`genindex`
+   * :ref:`modindex`

doc/source/install/index.rst

@@ -0,0 +1,21 @@
+==================
+Installation Guide
+==================
+
+System Requirements
+===================
+
+.. toctree::
+   :maxdepth: 1
+
+Installing from Packages
+========================
+
+.. toctree::
+   :maxdepth: 1
+
+Installing from Source
+======================
+
+.. toctree::
+   :maxdepth: 1

doc/source/user/index.rst

@@ -0,0 +1,6 @@
+========================================
+User Documentation
+========================================
+
+.. toctree::
+   :maxdepth: 1

tox.ini

@@ -29,6 +29,26 @@ passenv = *_proxy *_PROXY
 commands =
   make package
 
+[testenv:docs]
+deps =
+  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/requirements.txt
+  -r{toxinidir}/doc/requirements.txt
+commands =
+  rm -rf doc/build
+  sphinx-build -W -b html doc/source doc/build/html
+  # Ignore D001 since we allow lines in excess of 79 characters.
+  doc8 --ignore D001 --ignore-path .tox --ignore-path .venv --ignore-path node_modules --ignore-path doc/build --ignore-path skyline_console.egg-info -e .txt -e .rst -e .inc
+allowlist_externals = rm
+
+[testenv:pdf-docs]
+deps = {[testenv:docs]deps}
+allowlist_externals =
+  make
+commands =
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
 [testenv:releasenotes]
 description =
   Generate release notes.