update index page in documentation

liborsold · Oct 11, 2024 · fc991f8 · fc991f8
1 parent 68de93e
commit fc991f8
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 3 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/_sources/index.rst b/docs/build/html/_sources/index.rst
@@ -7,7 +7,7 @@
 Welcome to fuNEGF's documentation!
 ==================================
 
-The `fuNEGF project <https://github.com/liborsold/fuNEGF/>`_ is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
+The `fuNEGF project on GitHub <https://github.com/liborsold/fuNEGF/>`_ is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
 
 Quickstart
 ================

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -311,7 +311,7 @@ <h2> Contents </h2>
 
   <div class="section" id="welcome-to-funegf-s-documentation">
 <h1>Welcome to fuNEGF’s documentation!<a class="headerlink" href="#welcome-to-funegf-s-documentation" title="Permalink to this heading">#</a></h1>
-<p>The <a class="reference external" href="https://github.com/liborsold/fuNEGF/">fuNEGF project</a> is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green’s Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.</p>
+<p>The <a class="reference external" href="https://github.com/liborsold/fuNEGF/">fuNEGF project on GitHub</a> is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green’s Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.</p>
 <div class="section" id="quickstart">
 <h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this heading">#</a></h2>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">fuNEGF</span>

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,7 +7,7 @@
 Welcome to fuNEGF's documentation!
 ==================================
 
-The `fuNEGF project <https://github.com/liborsold/fuNEGF/>`_ is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
+The `fuNEGF project on GitHub <https://github.com/liborsold/fuNEGF/>`_ is a Python package for the calculation of the electronic transport properties of nanostructures using the Non-Equilibrium Green's Function (NEGF) formalism for educational purposes. Limited to a 1D linear chain for now.
 
 Quickstart
 ================