update documentation

docs/build/html/_sources/api.rst

@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   fuNEGF.models

docs/build/html/_sources/classes.rst

@@ -0,0 +1,9 @@
+Classes
+==============
+
+For now, there is the LinearChain class including both the model and NEGF solver routines. This will be in future separated into a generic System class, with child classes of different specific systems (like LinearChain). 
+
+.. autoclass:: fuNEGF.models.LinearChain
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/build/html/_sources/generated/fuNEGF.models.rst

@@ -0,0 +1,29 @@
+fuNEGF.models
+=============
+
+.. automodule:: fuNEGF.models
+
+
+
+
+
+
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      LinearChain
+
+
+
+
+
+
+
+
+

docs/build/html/_sources/generated/fuNEGF.rst

@@ -0,0 +1,23 @@
+fuNEGF
+======
+
+.. automodule:: fuNEGF
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

docs/build/html/_sources/index.rst

@@ -0,0 +1,26 @@
+.. fuNEGF documentation master file, created by
+   sphinx-quickstart on Tue Apr  9 17:51:34 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to fuNEGF's documentation!
+==================================
+
+**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.
+
+See the `fuNEGF project on GitHub <https://github.com/liborsold/fuNEGF/tree/master>`_.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/build/html/_static/locales/ar/LC_MESSAGES/booktheme.po

@@ -0,0 +1,75 @@
+
+msgid ""
+msgstr ""
+"Project-Id-Version: Sphinx-Book-Theme\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: ar\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Print to PDF"
+msgstr "طباعة إلى PDF"
+
+msgid "Theme by the"
+msgstr "موضوع بواسطة"
+
+msgid "Download source file"
+msgstr "تنزيل ملف المصدر"
+
+msgid "open issue"
+msgstr "قضية مفتوحة"
+
+msgid "Contents"
+msgstr "محتويات"
+
+msgid "previous page"
+msgstr "الصفحة السابقة"
+
+msgid "Download notebook file"
+msgstr "تنزيل ملف دفتر الملاحظات"
+
+msgid "Copyright"
+msgstr "حقوق النشر"
+
+msgid "Download this page"
+msgstr "قم بتنزيل هذه الصفحة"
+
+msgid "Source repository"
+msgstr "مستودع المصدر"
+
+msgid "By"
+msgstr "بواسطة"
+
+msgid "repository"
+msgstr "مخزن"
+
+msgid "Last updated on"
+msgstr "آخر تحديث في"
+
+msgid "Toggle navigation"
+msgstr "تبديل التنقل"
+
+msgid "Sphinx Book Theme"
+msgstr "موضوع كتاب أبو الهول"
+
+msgid "suggest edit"
+msgstr "أقترح تحرير"
+
+msgid "Open an issue"
+msgstr "افتح قضية"
+
+msgid "Launch"
+msgstr "إطلاق"
+
+msgid "Fullscreen mode"
+msgstr "وضع ملء الشاشة"
+
+msgid "Edit this page"
+msgstr "قم بتحرير هذه الصفحة"
+
+msgid "By the"
+msgstr "بواسطة"
+
+msgid "next page"
+msgstr "الصفحة التالية"

docs/build/html/_static/locales/bg/LC_MESSAGES/booktheme.po

@@ -0,0 +1,75 @@
+
+msgid ""
+msgstr ""
+"Project-Id-Version: Sphinx-Book-Theme\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: bg\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Print to PDF"
+msgstr "Печат в PDF"
+
+msgid "Theme by the"
+msgstr "Тема от"
+
+msgid "Download source file"
+msgstr "Изтеглете изходния файл"
+
+msgid "open issue"
+msgstr "отворен брой"
+
+msgid "Contents"
+msgstr "Съдържание"
+
+msgid "previous page"
+msgstr "предишна страница"
+
+msgid "Download notebook file"
+msgstr "Изтеглете файла на бележника"
+
+msgid "Copyright"
+msgstr "Авторско право"
+
+msgid "Download this page"
+msgstr "Изтеглете тази страница"
+
+msgid "Source repository"
+msgstr "Хранилище на източника"
+
+msgid "By"
+msgstr "От"
+
+msgid "repository"
+msgstr "хранилище"
+
+msgid "Last updated on"
+msgstr "Последна актуализация на"
+
+msgid "Toggle navigation"
+msgstr "Превключване на навигацията"
+
+msgid "Sphinx Book Theme"
+msgstr "Тема на книгата Sphinx"
+
+msgid "suggest edit"
+msgstr "предложи редактиране"
+
+msgid "Open an issue"
+msgstr "Отворете проблем"
+
+msgid "Launch"
+msgstr "Стартиране"
+
+msgid "Fullscreen mode"
+msgstr "Режим на цял екран"
+
+msgid "Edit this page"
+msgstr "Редактирайте тази страница"
+
+msgid "By the"
+msgstr "По"
+
+msgid "next page"
+msgstr "Следваща страница"

docs/build/html/_static/locales/bn/LC_MESSAGES/booktheme.po

@@ -0,0 +1,63 @@
+
+msgid ""
+msgstr ""
+"Project-Id-Version: Sphinx-Book-Theme\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Language: bn\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+msgid "Print to PDF"
+msgstr "পিডিএফ প্রিন্ট করুন"
+
+msgid "Theme by the"
+msgstr "থিম দ্বারা"
+
+msgid "Download source file"
+msgstr "উত্স ফাইল ডাউনলোড করুন"
+
+msgid "open issue"
+msgstr "খোলা সমস্যা"
+
+msgid "previous page"
+msgstr "আগের পৃষ্ঠা"
+
+msgid "Download notebook file"
+msgstr "নোটবুক ফাইল ডাউনলোড করুন"
+
+msgid "Copyright"
+msgstr "কপিরাইট"
+
+msgid "Download this page"
+msgstr "এই পৃষ্ঠাটি ডাউনলোড করুন"
+
+msgid "Source repository"
+msgstr "উত্স সংগ্রহস্থল"
+
+msgid "By"
+msgstr "দ্বারা"
+
+msgid "Last updated on"
+msgstr "সর্বশেষ আপডেট"
+
+msgid "Toggle navigation"
+msgstr "নেভিগেশন টগল করুন"
+
+msgid "Sphinx Book Theme"
+msgstr "স্পিনিক্স বুক থিম"
+
+msgid "Open an issue"
+msgstr "একটি সমস্যা খুলুন"
+
+msgid "Launch"
+msgstr "শুরু করা"
+
+msgid "Edit this page"
+msgstr "এই পৃষ্ঠাটি সম্পাদনা করুন"
+
+msgid "By the"
+msgstr "দ্বারা"
+
+msgid "next page"
+msgstr "পরবর্তী পৃষ্ঠা"