Merge pull request #9 from clodman84/docs

Docs
clodman84 · Jul 22, 2024 · 7d48e91 · 7d48e91
2 parents 0898cae + 50e679d
commit 7d48e91
Show file tree

Hide file tree

Showing 10 changed files with 137 additions and 6 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,8 +2,9 @@ dearpygui
 numpy
 Pillow
 pre-commit
+pydata-sphinx-theme
 pyparsing
 sounddevice
 soundfile
 sphinx-autoapi
-sphinx-rtd-theme
+sphinxcontrib-video
diff --git a/docs/source/Billing.webp b/docs/source/Billing.webp
diff --git a/docs/source/DJ.webm b/docs/source/DJ.webm
diff --git a/docs/source/Getting Started.rst b/docs/source/Getting Started.rst
@@ -0,0 +1,124 @@
+.. _Getting Started:
+
+Getting Started
+===============
+
+This may seem somewhat complicated, but it's much easier than it may feel like, so let's dive in!
+
+Loading The Mess List
+---------------------
+
+.. note::
+   This needs to be done only when you have downloaded the app for the first time or when the mess list has changed.
+
+The mess list is a csv file which consists of the ID Numbers, Names, Genders and Hostels of all the students in the college. You can keep it anywhere on your
+PC. To load the mess list, drag the :ref:`Logger` window away to reveal the toolbar located on the top of the main app window. Simply click on Tools -> Load Mess List.
+Any csv file will appear green. Simply select it. Upon succesful loading, a message will pop up, and za list will be loaded.
+
+.. image:: MessList.PNG
+  :width: 800
+
+
+Loading The Roll
+----------------
+
+The roll is a folder containing all the images in one *DoPy Roll*. It will have a maximum of 40 images (tradition), and will have a suffix of *R*. Load the roll similarly
+to the mess list (Tools->Load Roll). Choose the roll, and just click ok.
+
+
+Billing Window
+--------------
+
+.. image :: Billing.webp
+   :width: 800
+
+Using this window, you can search for names, IDs, hostels, etc. and bill them accordingly. The billing window comes with a parser built into so you can querry the database of students with more control.
+The parser syntax is confounding and stupefying at first, but like all things, when you break it down it becomes easier to grasp.
+
+So, if you directly type out text, the billing window returns a bunch of names, regardless of hostel, year, etc. In order to search for a particular
+**ID Number**, you need to enclose it in **forward slashes (/)** (for example, /0758/). For a particular **hostel**, you need to enlcose it in **square brackets ([])** (for example, [GN]).
+
+.. list-table:: Hostel IDs
+   :widths: 20 5
+   :header-rows: 1
+
+   * - Bhawan
+     - Code
+   * - Ashok
+     - AK
+   * - Budh
+     - BD
+   * - CV Raman
+     - CVR
+   * - Gandhi
+     - GN
+   * - Krishna
+     - KR
+   * - Malviya
+     - ML
+   * - Malviya Studio Apartments
+     - MSA
+   * - Meera
+     - MR
+   * - Ram
+     - RM
+   * - Rana Pratap
+     - RP
+   * - Shankar
+     - SK
+   * - Shrinivas Ramananujan (see the next entry)
+     - SR
+   * - Vishwakarma (no one calls it that)
+     - VK
+   * - Vyas
+     - VY
+
+
+Things get more interesting, though. something like /230758/ is a valid query. So is /0758/ and /A80720/ and /B4A3/, etc.
+ID is basically represented in the form **([0-9]{2}|)([a-zA-Z][0-9]|)([a-zA-Z][0-9]|)([0-9]{4}|)** (for example, **22B4A30000**).
+Therefore, /20230758/ doesnt work. Neither does a full ID like /2023AAPS0758P/.
+Higher degree students (masters and phd) can be found by searching for **H[0-9] (masters) and PHXP (phd)**.
+
+Also, when searching for names, no result will be displayed until three letters are typed out. When three letters are typed out, you get every single name
+that contains those three letters. So, typing *ush* will give you *usha*, *kaushik* as well as *kushi*. After that every letter further typed gives a name with those letters in succession. (This is because we use SQLite's fts5 engine with the `trigram <https://www.sqlite.org/fts5.html>`_ tokeniser).
+
+You can also use **& (AND/INTERSECTION)** and **| (OR/UNION)** with your queries. If you type surya | [GN], you get all the people who's name contains surya,
+*OR* they live in gandhi. If you type surya & [GN], you get all the people who's name contains surya *AND* they live in gandhi. The evaluation goes from
+left to right, and *unions are the outermost statement*, meaning *it will be evaluated with the least priority*. Brackets can also be added, which adds priority
+(surya | [GN]) & /0758/ will evaluate the brackets first, and then move on.
+
+As an example,
+**ram & /b4/ & [GN]|[KR]** queries all the people with ram in their name *AND* have the b4 branch *AND* live in gandhi, *OR* the people living in krishna.
+Basically it becomes **(ram & /b4/ & [GN])|([KR])**.
+
+.. image :: Parser.webp
+   :width: 800
+
+
+.. _Logger:
+
+Logger
+------
+
+The Logger, as the name implies, logs stuff! Nothing escapes its sight. You can filter out logs by typing into the text box. GUI.Music will show you only music related log messages and so on.
+
+.. image:: Logger.PNG
+
+
+Music
+-----
+
+.. note::
+   Although the internals for playing and visualising music are close to ready this feature is still unfinished. This will be implemented before BOSM.
+
+In the same toolbar as the Tools option, the Music option exists. The DJ is spawned upon selection, and it has three options; start, change and stop.
+Play the handpicked tunes lesgoo.
+
+.. video:: DJ.webm
+   :width: 600
+
+Dinosaur
+--------
+
+.. image:: giraffe.jpg
+  :width: 600
diff --git a/docs/source/Logger.PNG b/docs/source/Logger.PNG
diff --git a/docs/source/MessList.PNG b/docs/source/MessList.PNG
diff --git a/docs/source/Parser.webp b/docs/source/Parser.webp
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,7 +11,7 @@
 sys.path.insert(0, os.path.abspath("./../.."))
 print(sys.path)
 
-project = "Updated-Newer-Fresher-Version-3"
+project = "UNFv3"
 copyright = "2024, The Department of Photography"
 author = "The Department of Photography"
 release = "0.1.0-alpha"
@@ -23,7 +23,8 @@
     "autoapi.extension",
     "sphinx.ext.viewcode",
     "sphinx.ext.todo",
-    "sphinx_rtd_theme",
+    "pydata_sphinx_theme",
+    "sphinxcontrib.video",
 ]
 
 templates_path = ["_templates"]
@@ -33,5 +34,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
diff --git a/docs/source/giraffe.jpg b/docs/source/giraffe.jpg
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,15 +1,20 @@
 A Product of DoPySoft Inc.
 ==========================
 
+Konichiwa! Welcome to the **DoPy Billing App, also known as Updated-Newer-Fresher-Version-3**!
+This application was developed by PyDos (DoPy 2023) and is based on an `earlier <https://github.com/DoPyBITS/Billing-Software>`_ version of the DoPy Billing App.
+Updated-Newer-Fresher-Version-3 gets its name from `Updated-New-Fresh-Version-2 <https://github.com/DoPyBITS/Updated-New-Fresh-Version-2>`_.
+This newer version aims to be easy to update and maintain, and contributions from future batches are welcome (add whatever you want, it doesn't have to make sense).
+
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    Getting Started
 
-
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`