From b9559eccf8fd3c03b7866de79a3c5d57bcd50a21 Mon Sep 17 00:00:00 2001 From: Jonathan Holloway Date: Tue, 29 Nov 2016 20:43:41 -0600 Subject: docs: initial sphinx setup Change-Id: Ibeac5bba6423cbf93577d8d11cc8f3540e900a5a Signed-off-by: Jonathan Holloway --- docs/Makefile | 230 +++++++++++++++++++++++ docs/conf.py | 376 +++++++++++++++++++++++++++++++++++++ docs/index.rst | 36 ++++ docs/source/glustolibs.gluster.rst | 166 ++++++++++++++++ docs/source/glustolibs.rst | 17 ++ docs/source/modules.rst | 8 + docs/source/setup.rst | 7 + docs/userguide/intro.rst | 124 ++++++++++++ 8 files changed, 964 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/source/glustolibs.gluster.rst create mode 100644 docs/source/glustolibs.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/setup.rst create mode 100644 docs/userguide/intro.rst (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..a8b8dcb3c --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,230 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) + $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/glusto-tests.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/glusto-tests.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/glusto-tests" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/glusto-tests" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..b8eac0d1c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# +# glusto-tests documentation build configuration file, created by +# sphinx-quickstart on Wed Jun 1 19:57:06 2016. +# +# 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 sys +import os + +# 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('../glustolibs-gluster/')) + +# -- 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.napoleon', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +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'Glusto-Tests' +copyright = u'2016, Gluster Community' +author = 'Gluster Community' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'0.1' +# The full version, including alpha/beta/rc tags. +release = u'0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +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. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build'] + +# 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 + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = 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 = 'default' + +# 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. +# " v documentation" by default. +#html_title = u'Glusto-tests v0.1' + +# 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 (relative to this directory) to use as a 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 = ['source/_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 None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +#html_last_updated_fmt = None + +# 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 + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Glusto-tests_doc' + +# -- 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': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'Glusto-tests.tex', u'Glusto-tests Documentation', + u'Gluster Community', '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 = [ + (master_doc, 'glusto-tests', u'Glusto-tests Documentation', + [author], 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 = [ + (master_doc, 'Glusto-tests', u'Glusto-tests Documentation', + author, 'Gluster Community', '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 Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +#epub_basename = project + +# The HTML theme for the epub output. Since the default themes are not +# optimized for small screen space, using the same theme for HTML and epub +# output is usually not wise. This defaults to 'epub', a theme designed to save +# visual space. +#epub_theme = 'epub' + +# 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 a 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 = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +#epub_guide = () + +# 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 that 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 = ['search.html'] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +#epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +#epub_fix_images = False + +# Scale large images. +#epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#epub_show_urls = 'inline' + +# If false, no index is generated. +#epub_use_index = True + +autodoc_member_order = 'bysource' +autoclass_content = 'both' + +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = True +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 000000000..909d70b97 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,36 @@ +.. glusto-tests documentation master file, created by + sphinx-quickstart on Wed Jun 1 19:57:06 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to the Glusto-tests documentation! +========================================== + +Glusto-tests is a repository for gluster-related test libraries using Glusto. + +User Guide +---------- + +.. toctree:: + :maxdepth: 3 + + userguide/intro + + +API +=== + +.. toctree:: + :maxdepth: 2 + + source/glustolibs +.. source/glustolibs.io + + +Indices and Tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/glustolibs.gluster.rst b/docs/source/glustolibs.gluster.rst new file mode 100644 index 000000000..00fec031e --- /dev/null +++ b/docs/source/glustolibs.gluster.rst @@ -0,0 +1,166 @@ +glustolibs.gluster package +========================== + +Submodules +---------- + +glustolibs.gluster.bitrot_ops module +------------------------------------ + +.. automodule:: glustolibs.gluster.bitrot_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.brick_libs module +------------------------------------ + +.. automodule:: glustolibs.gluster.brick_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.brick_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.brick_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.gluster_base_class module +-------------------------------------------- + +.. automodule:: glustolibs.gluster.gluster_base_class + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.gluster_init module +-------------------------------------- + +.. automodule:: glustolibs.gluster.gluster_init + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.heal_libs module +----------------------------------- + +.. automodule:: glustolibs.gluster.heal_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.heal_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.heal_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.lib_utils module +----------------------------------- + +.. automodule:: glustolibs.gluster.lib_utils + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.mount_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.mount_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.peer_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.peer_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.quota_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.quota_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.rebalance_ops module +--------------------------------------- + +.. automodule:: glustolibs.gluster.rebalance_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.samba_ops module +----------------------------------- + +.. automodule:: glustolibs.gluster.samba_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.snap_ops module +---------------------------------- + +.. automodule:: glustolibs.gluster.snap_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.tiering_ops module +------------------------------------- + +.. automodule:: glustolibs.gluster.tiering_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.uss_ops module +--------------------------------- + +.. automodule:: glustolibs.gluster.uss_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.volume_libs module +------------------------------------- + +.. automodule:: glustolibs.gluster.volume_libs + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.volume_ops module +------------------------------------ + +.. automodule:: glustolibs.gluster.volume_ops + :members: + :undoc-members: + :show-inheritance: + +glustolibs.gluster.windows_libs module +-------------------------------------- + +.. automodule:: glustolibs.gluster.windows_libs + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: glustolibs.gluster + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/glustolibs.rst b/docs/source/glustolibs.rst new file mode 100644 index 000000000..127464972 --- /dev/null +++ b/docs/source/glustolibs.rst @@ -0,0 +1,17 @@ +glustolibs package +================== + +Subpackages +----------- + +.. toctree:: + + glustolibs.gluster + +Module contents +--------------- + +.. automodule:: glustolibs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 000000000..376c632dd --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,8 @@ +glustolibs-gluster +================== + +.. toctree:: + :maxdepth: 4 + + glustolibs + setup diff --git a/docs/source/setup.rst b/docs/source/setup.rst new file mode 100644 index 000000000..31789b12b --- /dev/null +++ b/docs/source/setup.rst @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/userguide/intro.rst b/docs/userguide/intro.rst new file mode 100644 index 000000000..276d06fae --- /dev/null +++ b/docs/userguide/intro.rst @@ -0,0 +1,124 @@ +Glusto Tests +------------ + +The **glusto-tests** repo contains automated testcases for testing gluster software. +It provides the Libraries/Modules necessary for automating tests for gluster under the Glusto framework. + +The Libraries/Modules/Tests in glusto-tests are written using the 'glusto' +framework. TestCases in glusto-tests can we written/run using standard +PyUnit, PyTest or Nose methodologies as supported by 'glusto' framework. + +Refer to 'http://glusto.readthedocs.io/en/latest/' for info on 'glusto' +framework. + +Prereqs +======= + +To automate/run glusto-tests we need to install the following packages: + +- glusto + +- glustolibs-gluster + +- glustolibs-io + +Installing Glusto +================= + +- pip install + +:: + + # pip install --upgrade git+git://github.com/loadtheaccumulator/glusto.git + +... or ... + +- git clone + +:: + + # git clone https://github.com/loadtheaccumulator/glusto.git + # cd glusto + # python setup.py + +Refer to: http://glusto.readthedocs.io/en/latest/userguide/install.html + +Installing Glustolibs +===================== + +To install the glustolibs-gluster and glustolibs-io libraries... + +:: + + # git clone http://review.gluster.org/glusto-tests + # cd glusto-tests/glustolibs-gluster + # python setup.py install + # cd glusto-tests/glustolibs-io + # python setup.py install + +How to run the test case +------------------------ +- Create config file containing info about the servers, clients, volumes, + mounts. Please refer to example config file under tests directory in + glusto-tests repo. The example config file is in yaml format and + defines sections which provides info about the gluster cluster. + We can use any 'glusto' framework supported formats for writing the + config files. + Refer : http://glusto.readthedocs.io/en/latest/userguide/configurable.html + +- glusto-tests are run using the 'glusto' command available after installing + the glusto framework. The various options to run tests as provided by + glusto framework: + +To run PyUnit tests + +:: + + # glusto -c 'config.yml' -d 'tests' + # glusto -c 'config.yml unittest_list.yml' -u + +To run PyTest tests: +:: + + # glusto -c 'config.yml' --pytest='-v -x tests -m bvt' + +To run Nose tests: +:: + + # glusto -c 'config.yml' --nosetests='-v -w tests' + + Refer: http://glusto.readthedocs.io/en/latest/userguide/glusto.html#options-for-running-unit-tests + +Writing tests in glusto-tests: +------------------------------ +The `tests` directory in glusto-tests contains testcases. One might want to create +a dir with feature name as the name of test directory under `tests` to add +new testcases. + +TestCases in glusto-tests can we written using standard PyUnit, PyTest or Nose +methodologies as supported by 'glusto' framework. + +For more information on PyUnit tests, see http://glusto.readthedocs.io/en/latest/userguide/unittest.html + +For more information on PyTest tests, see http://glusto.readthedocs.io/en/latest/userguide/pytest.html + +For more informaiton on Nose tests, see http://glusto.readthedocs.io/en/latest/userguide/nosetests.html + +Logging +-------- + +The Log file name and Log level can be passed as argument to glusto command while +running the glusto-tests. For example: + +:: + + # glusto -c 'config.yml' -l /tmp/glustotests_bvt.log --log-level DEBUG --pytest='-v -x tests -m bvt' + +One can configure log files, log levels in the testcases as well. For details +on how to use glusto framework for configuring logs in tests Refer to: +http://glusto.readthedocs.io/en/latest/userguide/loggable.html + +Default log location is '/tmp/glustomain.log'. + +Note: When using 'glusto' via the Python Interactive Interpreter, +the default log location is '/tmp/glusto.log'. -- cgit