+
+
+

Welcome to Keycloak Collection documentation

+
+

Pick collection version:

+
    diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..31502f3 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,170 @@ +# -*- 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 datetime +import os +import sys +sys.path.insert(0, os.path.abspath('../plugins/module_utils/')) +# sys.path.insert(0, os.path.abspath('.')) + +# -- Project information ----------------------------------------------------- + +project = 'Keycloak Ansible Collection' +copyright = '{y}, Red Hat, Inc.'.format(y=datetime.date.today().year) +author = 'Red Hat, Inc.' + +# The short X.Y version +version = '' +# The full version, including alpha/beta/rc tags +release = '' + + +# -- 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 = [ + 'myst_parser', + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'ansible_basic_sphinx_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', '.md'] + +# 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 = None + +# 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 = ['_build', 'Thumbs.db', '.DS_Store', '.tmp'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +highlight_language = 'YAML+Jinja' + +# -- Options for HTML output ------------------------------------------------- +html_theme_path = ['_themes'] +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +# html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' + +# 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 = [] + +# 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 = 'KeycloakCollectionDoc' + + +# -- 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, 'KeycloakCollection.tex', 'Red Hat Single Sign-On Ansible Collection Documentation', + 'Red Hat, Inc.', '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, 'keycloakcollection', 'Red Hat Single Sign-On Ansible Collection 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, 'KeycloakCollection', 'Red Hat Single Sign-On Ansible Collection Documentation', + author, 'KeycloakCollection', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'python': ('https://docs.python.org/2', None), 'ansible': ('https://docs.ansible.com/ansible/latest/', None)} diff --git a/docs/developing.md b/docs/developing.md new file mode 120000 index 0000000..44fcc63 --- /dev/null +++ b/docs/developing.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..dc5034f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,32 @@ +.. Red Hat middleware_automation Keycloak Ansible Collection documentation main file + +Welcome to Keycloak Collection documentation +============================================ + +.. toctree:: + :maxdepth: 2 + :caption: User documentation + + README + plugins/index + roles/index + +.. toctree:: + :maxdepth: 2 + :caption: Developer documentation + + developing + testing + releasing + +.. toctree:: + :maxdepth: 2 + :caption: General + + Changelog + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..72a7d48 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +antsibull>=0.17.0 +ansible-base>=2.10.12 +sphinx-rtd-theme +git+https://github.com/felixfontein/ansible-basic-sphinx-ext +myst-parser diff --git a/docs/roles.rst.template b/docs/roles.rst.template new file mode 100644 index 0000000..b025af6 --- /dev/null +++ b/docs/roles.rst.template @@ -0,0 +1,3 @@ +Role Index +========== + diff --git a/galaxy.yml b/galaxy.yml index bc17757..0fe0c42 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -22,6 +22,6 @@ dependencies: "middleware_automation.redhat_csp_download": ">=1.2.1" "middleware_automation.wildfly": ">=0.0.6" repository: https://github.com/ansible-middleware/keycloak -documentation: https://github.com/ansible-middleware/keycloak +documentation: https://ansible-middleware.github.io/keycloak homepage: https://github.com/ansible-middleware/keycloak issues: https://github.com/ansible-middleware/keycloak/issues diff --git a/roles/keycloak/meta/main.yml b/roles/keycloak/meta/main.yml index 8729169..ed05acb 100644 --- a/roles/keycloak/meta/main.yml +++ b/roles/keycloak/meta/main.yml @@ -6,7 +6,7 @@ collections: galaxy_info: role_name: keycloak namespace: middleware_automation - author: Romain Pelisse, Guido Grazioli + author: Romain Pelisse, Guido Grazioli, Pavan Kumar Motaparthi description: Install keycloak or Red Hat Single Sing-On server configurations company: Red Hat, Inc. @@ -17,7 +17,6 @@ galaxy_info: platforms: - name: EL versions: - - 7 - 8 galaxy_tags: diff --git a/roles/keycloak_realm/meta/main.yml b/roles/keycloak_realm/meta/main.yml index 441ccd8..04dff8a 100644 --- a/roles/keycloak_realm/meta/main.yml +++ b/roles/keycloak_realm/meta/main.yml @@ -13,7 +13,6 @@ galaxy_info: platforms: - name: EL versions: - - 7 - 8 galaxy_tags: