Fix of read the docs build issues

.gitignore

@@ -6,6 +6,8 @@
 *.so
 *.dylib
 bin
+!docs/build/
+docs/build/*
 testbin/*
 
 # Test binary, build with `go test -c`
@@ -31,4 +33,4 @@ test-e2e/kubeconfig
 vendor/*
 
 # use this directory for files during development that shouldn't be pushed
-temp/*
+temp/*

.readthedocs.yaml

@@ -1,25 +1,18 @@
-# .readthedocs.yaml
+---
+# .readthedocs.yml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-20.04
-  tools:
-    golang: "1.18"
-
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
-
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+  builder: html
+  configuration: docs/source/conf.py
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+# Optionally set the version of Python and requirements required to build your
+# docs
+python:
+  # version: 3.7
+  install:
+    - requirements: docs/source/requirements.txt

docs/build/html/_sources/your_first_cluster.rst.txt

@@ -5,26 +5,29 @@ Create a cluster, we need to create a cluster using the ipfs operator CRD.
 
 Create a file with the following information
 
-::
-  apiVersion: cluster.ipfs.io/v1alpha1
-  kind: Ipfs
-  metadata:
-    name: ipfs-sample-1
-  spec:
-    url: apps.jephilli-4-11-04-28-0655.devcluster.openshift.com 
-    ipfsStorage: 2Gi
-    clusterStorage: 2Gi
-    replicas: 5
-    public: true
+.. code-block:: yaml
+
+   apiVersion: cluster.ipfs.io/v1alpha1
+   kind: Ipfs
+   metadata:
+     name: ipfs-sample-1
+   spec:
+     url: apps.example.com 
+     ipfsStorage: 2Gi
+     clusterStorage: 2Gi
+     replicas: 5
+     public: true
 
 
 Adjust the storage requirements to meet your needs.
 
 Once you have made the necessary adjustments, apply it to your cluster with kubectl
-::
+.. code-block::bash
+
   kubectl create namespace my_cluster
   kubectl -n my_cluster apply -f ipfs.yaml
 
 Verify that the cluster has started by viewing the status of the cluster.
-::
+.. code-block::bash
+
   kubectl -n my_namespace status ipfs-sample-1

docs/build/html/your_first_cluster.html

@@ -75,33 +75,30 @@
 <h1>Your First Cluster<a class="headerlink" href="#your-first-cluster" title="Permalink to this heading"></a></h1>
 <p>Create a cluster, we need to create a cluster using the ipfs operator CRD.</p>
 <p>Create a file with the following information</p>
-<dl>
-<dt>::</dt><dd><p>apiVersion: cluster.ipfs.io/v1alpha1
-kind: Ipfs
-metadata:</p>
-<blockquote>
-<div><p>name: ipfs-sample-1</p>
-</div></blockquote>
-<dl class="simple">
-<dt>spec:</dt><dd><p>url: apps.jephilli-4-11-04-28-0655.devcluster.openshift.com
-ipfsStorage: 2Gi
-clusterStorage: 2Gi
-replicas: 5
-public: true</p>
-</dd>
-</dl>
-</dd>
-</dl>
-<p>Adjust the storage requirements to meet your needs.</p>
-<p>Once you have made the necessary adjustments, apply it to your cluster with kubectl</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kubectl</span> <span class="n">create</span> <span class="n">namespace</span> <span class="n">my_cluster</span>
-<span class="n">kubectl</span> <span class="o">-</span><span class="n">n</span> <span class="n">my_cluster</span> <span class="n">apply</span> <span class="o">-</span><span class="n">f</span> <span class="n">ipfs</span><span class="o">.</span><span class="n">yaml</span>
-</pre></div>
-</div>
-<p>Verify that the cluster has started by viewing the status of the cluster.</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">kubectl</span> <span class="o">-</span><span class="n">n</span> <span class="n">my_namespace</span> <span class="n">status</span> <span class="n">ipfs</span><span class="o">-</span><span class="n">sample</span><span class="o">-</span><span class="mi">1</span>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cluster.ipfs.io/v1alpha1</span><span class="w"></span>
+<span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ipfs</span><span class="w"></span>
+<span class="nt">metadata</span><span class="p">:</span><span class="w"></span>
+<span class="w">  </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ipfs-sample-1</span><span class="w"></span>
+<span class="nt">spec</span><span class="p">:</span><span class="w"></span>
+<span class="w">  </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">apps.example.com</span><span class="w"></span>
+<span class="w">  </span><span class="nt">ipfsStorage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2Gi</span><span class="w"></span>
+<span class="w">  </span><span class="nt">clusterStorage</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2Gi</span><span class="w"></span>
+<span class="w">  </span><span class="nt">replicas</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">5</span><span class="w"></span>
+<span class="w">  </span><span class="nt">public</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
 </pre></div>
 </div>
+<p>Adjust the storage requirements to meet your needs.</p>
+<p>Once you have made the necessary adjustments, apply it to your cluster with kubectl
+.. code-block::bash</p>
+<blockquote>
+<div><p>kubectl create namespace my_cluster
+kubectl -n my_cluster apply -f ipfs.yaml</p>
+</div></blockquote>
+<p>Verify that the cluster has started by viewing the status of the cluster.
+.. code-block::bash</p>
+<blockquote>
+<div><p>kubectl -n my_namespace status ipfs-sample-1</p>
+</div></blockquote>
 </section>
 
 

docs/source/conf.py

@@ -16,6 +16,7 @@
     'sphinx.ext.doctest',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
+    'sphinx.ext.autosectionlabel',
     'sphinx.ext.intersphinx',
     # 'autoapi.extension',
 ]

docs/source/getting_started.rst

@@ -6,12 +6,17 @@ This document explains methods that can be used to install the operator onto an
 No matter which method you choose, the same operator will be installed.
 
 **With helm**
-::
-helm install ipfs-operator ./helm/ipfs-operator
+
+
+.. code-block:: bash
+
+   helm install ipfs-operator ./helm/ipfs-operator
 
 **manually**
-::
-make install
+
+.. code-block:: bash
+
+   make install
 
 
 

docs/source/hacking.rst

@@ -3,17 +3,19 @@ Hacking
 
 Have you have found a bug in the operator or do you have an additional feature? That's great! Here are some tips.
 
-
-Running your own images.
+Running your own images
+=======================
 
 If you have edited the code, you would like to install it in your own cluster, you will first need an account on an image host like dockerhub. Once you have this, you can build, push, and install the image using the **IMG** environment variable
-::
-  export IMG=your-image-repo/ipfs-operator:version
-  make docker-build
-  make docker-push
-  make install
 
+.. code-block:: bash
+
+   export IMG=your-image-repo/ipfs-operator:version
+   make docker-build
+   make docker-push
+   make install
 
 Creating a pull request
+=======================
 
 Pull requests are welcome and encouraged. Please make pull reqeusts against https://github.com/redhat-et/ipfs-operator.

docs/source/index.rst

@@ -1,13 +1,13 @@
 IPFS Operator
 ===================================
 
-**IPFS Operator** is a `Kubernetes Operator <https://kubernetes.io/docs/concepts/extend-kubernetes/operator/>`
-designed to assist with running `IPFS Cluster <https://cluster.ipfs.io>`
+**IPFS Operator** is a `Kubernetes Operator <https://kubernetes.io/docs/concepts/extend-kubernetes/operator/>`_
+designed to assist with running `IPFS Cluster <https://cluster.ipfs.io>`_
 
 IPFS cluster is used as the storage backend for many important and interesting projects. Some of the community projects
-hosted using IPFS cluster are listed `here <https://collab.ipfscluster.io/>`. The largest known clusters are host to tens of millions of pins and host nearly 1PB of objects.
+hosted using IPFS cluster are listed `here <https://collab.ipfscluster.io/>`_. The largest known clusters are host to tens of millions of pins and host nearly 1PB of objects.
 
-The IPFS Operator brings this technology to kubernetes. This operator enables kubernetes users to create clusters consisting of hundreds of peers quickly and easily. See _getting_started to begin.
+The IPFS Operator brings this technology to kubernetes. This operator enables kubernetes users to create clusters consisting of hundreds of peers quickly and easily. See :ref:`Getting Started` to begin.
 
 .. note::
 

docs/source/requirements.txt

@@ -0,0 +1,7 @@
+mypy
+plantweb
+pylint
+rstcheck
+sphinx_rtd_theme
+sphinx-tabs
+sphinx-toolbox

docs/source/your_first_cluster.rst

@@ -5,26 +5,31 @@ Create a cluster, we need to create a cluster using the ipfs operator CRD.
 
 Create a file with the following information
 
-::
-  apiVersion: cluster.ipfs.io/v1alpha1
-  kind: Ipfs
-  metadata:
-    name: ipfs-sample-1
-  spec:
-    url: apps.jephilli-4-11-04-28-0655.devcluster.openshift.com 
-    ipfsStorage: 2Gi
-    clusterStorage: 2Gi
-    replicas: 5
-    public: true
+.. code-block:: yaml
+
+   apiVersion: cluster.ipfs.io/v1alpha1
+   kind: Ipfs
+   metadata:
+     name: ipfs-sample-1
+   spec:
+     url: apps.example.com 
+     ipfsStorage: 2Gi
+     clusterStorage: 2Gi
+     replicas: 5
+     public: true
 
 
 Adjust the storage requirements to meet your needs.
 
 Once you have made the necessary adjustments, apply it to your cluster with kubectl
-::
+
+.. code-block:: bash
+
   kubectl create namespace my_cluster
   kubectl -n my_cluster apply -f ipfs.yaml
 
 Verify that the cluster has started by viewing the status of the cluster.
-::
+
+.. code-block:: bash
+
   kubectl -n my_namespace status ipfs-sample-1