Merge pull request #70 from cooktheryan/main

Fix of read the docs build issues

Author: cooktheryan

.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/doctrees/environment.pickle

@@ -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/doctrees/getting_started.doctree

@@ -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>