From b0b8d8e4f6093d18db16d8c56a12f610c3b36c99 Mon Sep 17 00:00:00 2001 From: Jindrich Luza Date: Mon, 24 Feb 2020 15:52:26 +0100 Subject: [PATCH] Added missing docs folder --- docs/Makefile | 20 ++++ docs/make.bat | 36 ++++++ docs/source/CHANGELOG.rst | 8 ++ docs/source/README.rst | 1 + docs/source/conf.py | 165 +++++++++++++++++++++++++++ docs/source/index.rst | 25 ++++ docs/source/modules/add_bundles.rst | 23 ++++ docs/source/modules/rm_operators.rst | 25 ++++ 8 files changed, 303 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/CHANGELOG.rst create mode 120000 docs/source/README.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules/add_bundles.rst create mode 100644 docs/source/modules/rm_operators.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..b2418de --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = pubtools-iib +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..a6955e6 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=pubtools-iib + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/source/CHANGELOG.rst b/docs/source/CHANGELOG.rst new file mode 100644 index 0000000..3b7059b --- /dev/null +++ b/docs/source/CHANGELOG.rst @@ -0,0 +1,8 @@ +ChangeLog +========= + +0.1.0 (2020-02-18) +------------------ + +* Initial release. + diff --git a/docs/source/README.rst b/docs/source/README.rst new file mode 120000 index 0000000..c768ff7 --- /dev/null +++ b/docs/source/README.rst @@ -0,0 +1 @@ +../../README.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..5048fc4 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,165 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# 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. +# +import os +import sys + +sys.path.append(os.path.abspath("../..")) + + +# -- Project information ----------------------------------------------------- + +project = u"pubtools-iib" +copyright = u"2020, Jindrich Luza" +author = u"Jindrich Luza" + +# The short X.Y version +version = u"0.1" +# The full version, including alpha/beta/rc tags +release = u"0.1.0" + + +# -- 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.viewcode", "sphinxarg.ext"] + +# 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 master toctree document. +master_doc = "index" + +# 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 = u"en" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# 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. See the documentation for +# a list of builtin themes. +# +html_theme = "alabaster" + +# 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 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"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "pubtools-iibdoc" + + +# -- 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, + "pubtools-iib.tex", + u"pubtools-iib Documentation", + u"Jindrich Luza", + "manual", + ) +] + + +# -- 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, "pubtools-iib", u"pubtools-iib Documentation", [author], 1)] + + +# -- 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, + "pubtools-iib", + u"pubtools-iib Documentation", + author, + "pubtools-iib", + "One line description of project.", + "Miscellaneous", + ) +] + + +# -- Extension configuration ------------------------------------------------- + +html_theme = "sphinx_rtd_theme" diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..add7379 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,25 @@ +pubtools-iib's documentation +============================ + +Contents: + +.. toctree:: + :maxdepth: 2 + + README + modules/add_bundles + modules/rm_operators + +.. ##### ToDo: Rewrite about documentation indexes. ##### + +.. toctree:: + :maxdepth: 1 + + CHANGELOG + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules/add_bundles.rst b/docs/source/modules/add_bundles.rst new file mode 100644 index 0000000..8f42834 --- /dev/null +++ b/docs/source/modules/add_bundles.rst @@ -0,0 +1,23 @@ +Pubtools-iib-add-bundles +======================== + + +.. argparse:: + :module: pubtools.iib.iib_ops + :func: make_add_bundles_parser + :prog: pubtools-iib-add-bundles + +Example of usage +------------------ + +:: + + $ export PULP_PASSWORD="pulppassword" + $ pubtools-iib-add-bundles --pulp-url https://pulphost.example.com/\ + --pulp-user pulp-user\ + --pulp-repository index-image-repository\ + --iib-server iibhostname.example.com\ + --binary-image container-registry.example.com/binary/image:latest + --index-image container-registry.example.com/index/image:latest + --bundle container-registry.example.com/bundle/image:123 + --arch x86_64 diff --git a/docs/source/modules/rm_operators.rst b/docs/source/modules/rm_operators.rst new file mode 100644 index 0000000..a63aeeb --- /dev/null +++ b/docs/source/modules/rm_operators.rst @@ -0,0 +1,25 @@ +Pubtools-iib-remove-operators +============================= + + +.. argparse:: + :module: pubtools.iib.iib_ops + :func: make_rm_operators_parser + :prog: pubtools-iib-remove-operators + + +Example of usage +------------------ + +:: + + $ export PULP_PASSWORD="pulppassword" + $ pubtools-iib-remove-operators --pulp-url https://pulphost.example.com/\ + --pulp-user pulp-user\ + --pulp-repository index-image-repository\ + --iib-server iibhostname.example.com\ + --binary-image container-registry.example.com/binary/image:latest + --index-image container-registry.example.com/index/image:latest + --operator bundle/image:123 + --arch x86_64 +