Fixed & rebased publishing on GitHub pages

Signed-off-by: Andreas Maier <maiera@de.ibm.com>
zhmcclient · Nov 9, 2020 · ebd12f7 · ebd12f7
1 parent 310e145
commit ebd12f7
Show file tree

Hide file tree

Showing 24 changed files with 203 additions and 220 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,7 @@
 /env
 env*
 /venv
-/doc_check/
+/docs_linkcheck/
 /build/
 /htmlcov/
 .coverage

diff --git a/Makefile b/Makefile
@@ -112,6 +112,7 @@ sanity_tar_file := tmp_workspace.tar
 
 # Directories for documentation
 doc_source_dir := docs_source
+doc_linkcheck_dir := docs_linkcheck
 doc_build_dir := docs
 
 # All documentation RST files (including module RST files)
@@ -189,12 +190,12 @@ develop: _check_version develop_$(pymn).done
 	@echo '$@ done.'
 
 .PHONY: docs
-docs: _check_version develop_$(pymn).done $(doc_build_dir)/html/index.html
+docs: _check_version develop_$(pymn).done $(doc_build_dir)/index.html
 	@echo '$@ done.'
 
 .PHONY: linkcheck
 linkcheck: _check_version develop_$(pymn).done $(doc_rst_files)
-	-sphinx-build -b linkcheck $(sphinx_opts) $(doc_source_dir) $(doc_build_dir)/linkcheck
+	-sphinx-build -b linkcheck $(sphinx_opts) $(doc_source_dir) $(doc_linkcheck_dir)
 	@echo '$@ done.'
 
 .PHONY: test
@@ -231,7 +232,7 @@ endif
 
 .PHONY: clobber
 clobber:
-	rm -Rf .cache .pytest_cache $(doc_build_dir) $(sanity_dir1) $(sanity_tar_file) htmlcov .tox
+	rm -Rf .cache .pytest_cache $(sanity_dir1) $(sanity_tar_file) htmlcov .tox
 	rm -f MANIFEST MANIFEST.in AUTHORS ChangeLog .coverage *.done
 	find . -name "*.pyc" -delete -o -name "__pycache__" -delete -o -name "*.tmp" -delete -o -name "tmp_*" -delete
 	@echo '$@ done.'
@@ -276,7 +277,7 @@ else
 	ansible-doc-extractor $(module_rst_dir) $<
 endif
 
-$(doc_build_dir)/html/index.html: $(doc_rst_files) $(doc_source_dir)/conf.py
+$(doc_build_dir)/index.html: $(doc_rst_files) $(doc_source_dir)/conf.py
 ifneq ($(doc_build),true)
 	@echo "makefile: Warning: Skipping docs build on Python $(python_m_n_version)"
 else

diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Contributing &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>Contributing &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -85,7 +85,6 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#format-of-commit-messages">Format of commit messages</a></li>
@@ -108,7 +107,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 

diff --git a/docs/all_modules.html b/docs/all_modules.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>All modules &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>All modules &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -98,7 +98,6 @@
 <li class="toctree-l2"><a class="reference internal" href="modules/zhmc_virtual_function.html">zhmc_virtual_function – Manages virtual functions in partitions of Z systems.</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a></li>
@@ -118,7 +117,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 

diff --git a/docs/appendix.html b/docs/appendix.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Appendix &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>Appendix &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -85,7 +85,6 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Appendix</a><ul>
@@ -112,7 +111,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 

diff --git a/docs/changes.html b/docs/changes.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Change log &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>Change log &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -50,7 +50,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -84,7 +84,6 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a></li>
@@ -114,7 +113,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 

diff --git a/docs/development.html b/docs/development.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Development &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>Development &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Contributing" href="CONTRIBUTING.html" />
-    <link rel="prev" title="Module Maintenance &amp; Support" href="modules_support.html" /> 
+    <link rel="prev" title="zhmc_virtual_function – Manages virtual functions in partitions of Z systems." href="modules/zhmc_virtual_function.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -51,7 +51,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -85,7 +85,6 @@
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Development</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#repository">Repository</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#setting-up-the-development-environment">Setting up the development environment</a></li>
@@ -113,7 +112,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 
@@ -509,7 +508,7 @@
         <a href="CONTRIBUTING.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="modules_support.html" class="btn btn-neutral float-left" title="Module Maintenance &amp; Support" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="modules/zhmc_virtual_function.html" class="btn btn-neutral float-left" title="zhmc_virtual_function – Manages virtual functions in partitions of Z systems." accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>Index &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>Index &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -49,7 +49,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -83,7 +83,6 @@
               <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a></li>
@@ -103,7 +102,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">zHMC Ansible modules</a>
+          <a href="index.html">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 

diff --git a/docs/index.html b/docs/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>ibm.zhmc Ansible modules &mdash; zHMC Ansible modules 1.0.0 documentation</title>
+  <title>ibm.zhmc Ansible Galaxy collection &mdash; ibm.zhmc Ansible Galaxy collection 1.0.0 documentation</title>
 
 
 
@@ -50,7 +50,7 @@
 
 
 
-            <a href="#" class="icon icon-home" alt="Documentation Home"> zHMC Ansible modules
+            <a href="#" class="icon icon-home" alt="Documentation Home"> ibm.zhmc Ansible Galaxy collection
 
 
 
@@ -84,7 +84,6 @@
               <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
 <li class="toctree-l1"><a class="reference internal" href="all_modules.html">All modules</a></li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
 <li class="toctree-l1"><a class="reference internal" href="CONTRIBUTING.html">Contributing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="appendix.html">Appendix</a></li>
@@ -104,7 +103,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="#">zHMC Ansible modules</a>
+          <a href="#">ibm.zhmc Ansible Galaxy collection</a>
 
       </nav>
 
@@ -135,7 +134,7 @@
 
       <li><a href="#" class="icon icon-home"></a> &raquo;</li>
 
-      <li>ibm.zhmc Ansible modules</li>
+      <li>ibm.zhmc Ansible Galaxy collection</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -152,8 +151,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <div class="section" id="ibm-zhmc-ansible-modules">
-<h1>ibm.zhmc Ansible modules<a class="headerlink" href="#ibm-zhmc-ansible-modules" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="ibm-zhmc-ansible-galaxy-collection">
+<h1>ibm.zhmc Ansible Galaxy collection<a class="headerlink" href="#ibm-zhmc-ansible-galaxy-collection" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound" id="mastertoc">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul>
@@ -182,12 +181,6 @@ <h1>ibm.zhmc Ansible modules<a class="headerlink" href="#ibm-zhmc-ansible-module
 <li class="toctree-l2"><a class="reference internal" href="modules/zhmc_virtual_function.html">zhmc_virtual_function – Manages virtual functions in partitions of Z systems.</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="modules_support.html">Module Maintenance &amp; Support</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="modules_support.html#maintenance">Maintenance</a></li>
-<li class="toctree-l2"><a class="reference internal" href="modules_support.html#issue-reporting">Issue Reporting</a></li>
-<li class="toctree-l2"><a class="reference internal" href="modules_support.html#support">Support</a></li>
-</ul>
-</li>
 <li class="toctree-l1"><a class="reference internal" href="development.html">Development</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="development.html#repository">Repository</a></li>
 <li class="toctree-l2"><a class="reference internal" href="development.html#setting-up-the-development-environment">Setting up the development environment</a></li>