added examples
This commit is contained in:
24
docs/build/_sources/index.rst.txt
vendored
Normal file
24
docs/build/_sources/index.rst.txt
vendored
Normal file
@@ -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`
|
||||
16
docs/build/_sources/index/usage.rst.txt
vendored
Normal file
16
docs/build/_sources/index/usage.rst.txt
vendored
Normal file
@@ -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
|
||||
|
||||
|
||||
16
docs/build/_sources/usage.rst.txt
vendored
Normal file
16
docs/build/_sources/usage.rst.txt
vendored
Normal file
@@ -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
|
||||
|
||||
|
||||
16
docs/build/_sources/usage/index.rst.txt
vendored
Normal file
16
docs/build/_sources/usage/index.rst.txt
vendored
Normal file
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user