From abb58a8d06235ce31d9d7ce171af45757e54dc53 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 16 Nov 2017 15:40:00 +0100 Subject: [PATCH] Remove separate firstapp build With the large reorg of the docs site, this can be easily *only* as part of the murano documentation, there's no benefit for publishing an extra document elsewhere. Fully integrate the documents into the manual. Note that the separate build target was not linked from any of our index sites. Remove extra title from README.rst, it let to duplicated title in main table of contents. Remove also post job for publishing the firstapp document - it currently fails - and is now not needed anymore. Change-Id: Ib5259907b3f999062042e483ac81e6aed17705ca --- .zuul.yaml | 4 - .../{source => }/Before_the_start.rst | 0 ...ng_and_troubleshooting_your_murano_app.rst | 0 .../Develop_murano_app_for_plone.rst | 0 ..._murano_app_in_the_application_catalog.rst | 0 doc/source/first-app/README.rst | 14 +- .../{source => }/What_is_the_use_case.rst | 0 .../{source => }/What_you_will_learn.rst | 0 .../{source => }/Who_is_this_guide_for.rst | 0 doc/source/first-app/{source => }/index.rst | 2 +- doc/source/first-app/source/conf.py | 289 ------------------ doc/source/index.rst | 2 +- tox.ini | 3 - 13 files changed, 4 insertions(+), 310 deletions(-) rename doc/source/first-app/{source => }/Before_the_start.rst (100%) rename doc/source/first-app/{source => }/Debugging_and_troubleshooting_your_murano_app.rst (100%) rename doc/source/first-app/{source => }/Develop_murano_app_for_plone.rst (100%) rename doc/source/first-app/{source => }/Publish_your_murano_app_in_the_application_catalog.rst (100%) rename doc/source/first-app/{source => }/What_is_the_use_case.rst (100%) rename doc/source/first-app/{source => }/What_you_will_learn.rst (100%) rename doc/source/first-app/{source => }/Who_is_this_guide_for.rst (100%) rename doc/source/first-app/{source => }/index.rst (93%) delete mode 100644 doc/source/first-app/source/conf.py diff --git a/.zuul.yaml b/.zuul.yaml index ed600e9d6..888269cda 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -24,10 +24,6 @@ experimental: jobs: - legacy-murano-dsvm-functional - post: - jobs: - - legacy-murano-firstapp-docs: - branches: ^(?!bug/).*$ - job: name: murano-congress-devstack-dsvm diff --git a/doc/source/first-app/source/Before_the_start.rst b/doc/source/first-app/Before_the_start.rst similarity index 100% rename from doc/source/first-app/source/Before_the_start.rst rename to doc/source/first-app/Before_the_start.rst diff --git a/doc/source/first-app/source/Debugging_and_troubleshooting_your_murano_app.rst b/doc/source/first-app/Debugging_and_troubleshooting_your_murano_app.rst similarity index 100% rename from doc/source/first-app/source/Debugging_and_troubleshooting_your_murano_app.rst rename to doc/source/first-app/Debugging_and_troubleshooting_your_murano_app.rst diff --git a/doc/source/first-app/source/Develop_murano_app_for_plone.rst b/doc/source/first-app/Develop_murano_app_for_plone.rst similarity index 100% rename from doc/source/first-app/source/Develop_murano_app_for_plone.rst rename to doc/source/first-app/Develop_murano_app_for_plone.rst diff --git a/doc/source/first-app/source/Publish_your_murano_app_in_the_application_catalog.rst b/doc/source/first-app/Publish_your_murano_app_in_the_application_catalog.rst similarity index 100% rename from doc/source/first-app/source/Publish_your_murano_app_in_the_application_catalog.rst rename to doc/source/first-app/Publish_your_murano_app_in_the_application_catalog.rst diff --git a/doc/source/first-app/README.rst b/doc/source/first-app/README.rst index f662aa120..256082048 100644 --- a/doc/source/first-app/README.rst +++ b/doc/source/first-app/README.rst @@ -1,7 +1,3 @@ -========================================== -My first Murano App getting started guide -========================================== - This directory contains the "My first Murano App getting started guide" tutorial. @@ -27,17 +23,11 @@ top-level :code:`test-requirements.txt`. You must also install `Graphviz `_ on your build system. -The following command invokes :code:`sphinx-build` with :code:`murano-firstapp`:: +The document is build as part of the docs build, for example using:: - tox -e murano-firstapp + tox -e docs /samples ~~~~~~~~ The code samples in this guide are located in this directory. - -/build/murano-firstapp -~~~~~~~~~~~~~~~~~~~~~~ - -The HTML documentation is built in this directory. The :code:`.gitignore` file -for the project specifies this directory. diff --git a/doc/source/first-app/source/What_is_the_use_case.rst b/doc/source/first-app/What_is_the_use_case.rst similarity index 100% rename from doc/source/first-app/source/What_is_the_use_case.rst rename to doc/source/first-app/What_is_the_use_case.rst diff --git a/doc/source/first-app/source/What_you_will_learn.rst b/doc/source/first-app/What_you_will_learn.rst similarity index 100% rename from doc/source/first-app/source/What_you_will_learn.rst rename to doc/source/first-app/What_you_will_learn.rst diff --git a/doc/source/first-app/source/Who_is_this_guide_for.rst b/doc/source/first-app/Who_is_this_guide_for.rst similarity index 100% rename from doc/source/first-app/source/Who_is_this_guide_for.rst rename to doc/source/first-app/Who_is_this_guide_for.rst diff --git a/doc/source/first-app/source/index.rst b/doc/source/first-app/index.rst similarity index 93% rename from doc/source/first-app/source/index.rst rename to doc/source/first-app/index.rst index 3d1b66f04..bcf505fb6 100644 --- a/doc/source/first-app/source/index.rst +++ b/doc/source/first-app/index.rst @@ -2,7 +2,7 @@ My first Murano App getting started guide ========================================= -.. include:: ../README.rst +.. include:: README.rst Contents ~~~~~~~~ diff --git a/doc/source/first-app/source/conf.py b/doc/source/first-app/source/conf.py deleted file mode 100644 index 25f6e18d3..000000000 --- a/doc/source/first-app/source/conf.py +++ /dev/null @@ -1,289 +0,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. - -# 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 subprocess - -# 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'] - -# 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'Murano-FirstApp' -copyright = u'2016, OpenStack contributors' - -# openstackdocstheme options -repository_name = 'openstack/murano' -bug_project = 'murano' -bug_tag = u'murano-firstapp' - -# The version info for the project you are documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# 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. -# So that we can enable "log-a-bug" links from each output HTML page, this -# variable must be set to a format that includes year, month, day, hours and -# minutes. -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 = False - -# 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 = False - -# 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 = 'MuranoFirstAppdoc' - -# If true, publish source files -html_copy_source = False - -# -- 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', 'FirstApp.tex', u'FirstApp Documentation', -# u'OpenStack Doc Team', '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', 'firstapp', u'FirstApp Documentation', -# [u'OpenStack Doc Team'], 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', 'FirstApp', u'FirstApp Documentation', -# u'OpenStack Doc Team', 'FirstApp', '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 - -# Set to True to enable printing of the TODO sections -todo_include_todos = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] - -# -- Options for PDF output -------------------------------------------------- - -#pdf_documents = [ -# ('index', u'FirstApp', u'FirstApp Documentation', -# u'OpenStack contributors') -#] diff --git a/doc/source/index.rst b/doc/source/index.rst index aaed776cc..6b7226730 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -86,7 +86,7 @@ A guide for developing your first Murano application. .. toctree:: :maxdepth: 1 - first-app/source/index + first-app/index Application Developer Documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tox.ini b/tox.ini index 636eee7e2..a87d2407d 100644 --- a/tox.ini +++ b/tox.ini @@ -47,9 +47,6 @@ commands = [testenv:docs] commands = python setup.py build_sphinx -[testenv:murano-firstapp] -commands = sphinx-build -E -W -d doc/build/murano-firstapp/doctrees -b html doc/source/first-app/source doc/build/murano-firstapp/html - [testenv:pyflakes] deps = flake8 commands = flake8