Skip to content

Commit

Permalink
.
Browse files Browse the repository at this point in the history
  • Loading branch information
SermetPekin committed Apr 18, 2024
1 parent a328b0c commit 8da5baf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/source/home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ To install evdspy, simply run the following command:
Quick Start
-----------
Here's a quick example to get you started with using evdspy:

.. code-block:: python
from evdspy import get_series, default_start_date_fnc, default_end_date_fnc
Expand All @@ -48,6 +49,7 @@ Here's a quick example to get you started with using evdspy:
API Usage Examples
------------------

.. literalinclude:: ../../evdspy_example.py
:language: python
:linenos:
Expand All @@ -57,6 +59,7 @@ Menus and Commands
------------------
- **Main Menu**: Access a user-friendly menu to manage data requests and settings.
- **Console Commands**: Use terminal commands to manage settings and request data:

.. code-block:: bash
evdspy setup
Expand Down
10 changes: 9 additions & 1 deletion docs/source/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,30 @@ setup Function
==============
The ``setup`` function initializes the application environment by performing multiple preparatory steps essential for the application's operation. This function encapsulates tasks such as configuring settings, initializing data structures, and preparing necessary resources.
.. autofunction:: evdspy.setup

Function Details
----------------
.. autofunction:: evdspy.setup

Purpose
-------
The function is designed to:
- Initialize base settings and configurations via ``SetupInitial().setup()``
- Configure additional settings specific to the application setup phase with ``start_setup_config(onsetup=True)``
- Create initial data examples necessary for the application with ``create_series_text_example(onsetup=True)``

Usage
-----
The ``setup`` function is typically called at the beginning of the application's lifecycle, before any other operations or user interactions occur.

Example Usage
-------------
This function is generally used without arguments and does not return any value:
.. code-block:: python
from evdspy import setup
setup()
This call ensures that all initial configurations and setups are correctly executed, preparing the application for use.
This call ensures that all initial configurations and setups are correctly executed, preparing the application for use.

0 comments on commit 8da5baf

Please sign in to comment.