added examples

docs/source/conf.py

@@ -0,0 +1,28 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'fn_gen'
+copyright = '2024, Ali Nwegy'
+author = 'Ali Nwegy'
+release = '"0.0.1"'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,24 @@
+.. fn_gen documentation master file, created by
+   sphinx-quickstart on Tue Jan 16 17:51:58 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to fn_gen's documentation!
+==================================
+
+**fn_gen** (/ˈfʌŋkʃən ˈʤɛnəˌreɪtər/) is a Python library for usage with SCPI (Simple Command Protocol for measurement Instruments) compliant function generators.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/usage.rst

@@ -0,0 +1,16 @@
+Usage
+=====
+
+Installation
+------------
+
+To use fn_gen, you need to first build it using python build:
+
+.. code-block:: console
+
+	(.venv) $ pip install build
+	(.venv) $ python -m build
+	(.venv) $ deactivate
+	$ pip install dist/fn_gen-0.0.1-py3-none-any.whl 
+	
+