docs1

bsroseman · bsroseman · commit 0d186db5cf53 · 2023-09-20T08:59:33.000-05:00
diff --git a/docs/source/_static/favicons/IMG_8324.jpg.jpeg b/docs/source/_static/favicons/IMG_8324.jpg.jpeg
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -1,5 +1,7 @@
+
+==================
 MoabDB API
-##########
+==================
 
 .. toctree::
    :maxdepth: 2
@@ -11,9 +13,3 @@ MoabDB API
    api/get_bs
    api/get_cf
    api/get_is
-   .. get_equity
-   .. get_options
-   .. get_rates
-   .. get_is
-   .. get_bs
-   .. get_cf
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -52,7 +52,7 @@
 
 html_theme = "sphinx_book_theme"
 html_title = f'<strong>{project}</strong> <i>{release}</i>'
-html_favicon = '_static/favicon.ico'
+html_favicon = '_static/favicon-32x32.ico'
 html_baseurl = 'https://docs.moabdb.com/'
 html_static_path = ['_static']
 html_css_files = ["custom.css"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,8 +3,6 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-
-
 ====================================
 MoabDB API and Dataset Documentation
 ====================================
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -1,5 +1,7 @@
+
+==================
 Getting Started
-###############
+==================
 
 The tutorial series walks you through common problems and solutions
 using python and MoabDB.
diff --git a/docs/source/tutorial/intraday_plot.rst b/docs/source/tutorial/intraday_plot.rst
@@ -34,23 +34,21 @@ Prior to running this example, you should have the following:
   
   .. code-block:: python
 
-        import configparser
         import moabdb as mdb
-        import matplotlib.pyplot as plt
-        import matplotlib.dates as mdates
 
         # Constants defined here for flexibility
-        TIC = 'MSFT'
-        SAMPLE = '1d'
-        DAY_START = '9:30'
-        DAY_END = '16:00'
+        # TIC = 'MSFT'
+        # SAMPLE = '1d'
+        # DAY_START = '9:30'
+        # DAY_END = '16:00'
 
-        # Reading in credentials from config.ini file
         # Read credentials from config file
         config = configparser.ConfigParser()
         config.read('config.ini')
         email = config.get("Credentials", "email")
         api_key = config.get("Credentials", "api_key")
+
+        # MoabDB login
         mdb.login(email, api_key)
 
 
diff --git a/docs/source/tutorial/quickstart.rst b/docs/source/tutorial/quickstart.rst
@@ -1,13 +1,15 @@
+
+====================
 Quickstart
-##########
+====================
 
 Getting Started with MoabDB
-===========================
+---------------------------
 
 Welcome to the MoabDB documentation! If you're new to MoabDB, this guide will help you set up and make your first API call.
 
 Prerequisites
--------------
+^^^^^^^^^^^^^
 
 Before you begin:
 
@@ -17,7 +19,7 @@ Before you begin:
 
 
 Install and Load Library
-========================
+------------------------
 
 You can install the MoabDB library using ``pip``.
 
@@ -34,7 +36,7 @@ Once installed, you can load the library in your Python code.
 
 
 Data Access without API Key
-===========================
+---------------------------
 
 To access basic data, you do not need an API key.
 The ``get_equity()`` function can be used to 
@@ -52,7 +54,7 @@ access end-of-day stock data.
 
 
 Advanced Data Access with API Key
-=================================
+---------------------------------
 
 With an API key and subscription, intraday data and other
 advanced datasets are available. 
@@ -65,7 +67,7 @@ credentials by either:
 You then can use the ``mdb.login()`` function to login with your credentials.
 
 Manually Entering Credentials
------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To access advanced data you must first login with your API key.
 
@@ -79,7 +81,7 @@ To access advanced data you must first login with your API key.
 
 
 Using ``config.ini`` File for Credentials
------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Instead of hardcoding your email and API key in the code, a safer practice is to store them in a configuration file. 
 This method prevents the accidental exposure of sensitive credentials, especially if sharing or publishing your code.
diff --git a/docs/source/tutorial/simple_plot.rst b/docs/source/tutorial/simple_plot.rst
@@ -1,10 +1,12 @@
+
+=================================
 Plotting Daily-Level Stock Prices
-#################################
+=================================
 
 .. image:: https://img.shields.io/pypi/v/moabdb.svg
    :target: https://pypi.python.org/pypi/moabdb
    :alt: PyPI Version
-   
+
 In this guide, we will walk you through the steps to retrieve 
 financial data using MoabDB and how to create a basic 
 chart using the `matplotlib` library.
@@ -20,7 +22,7 @@ three examples of plotting data:
 
 
 Prerequisites
-=============
+-------------
 
 - You will need `matplotlib` installed. If you haven't already, you can install it with:
 
@@ -30,12 +32,12 @@ Prerequisites
 
 
 Plotting Single Stock with Daily-Level Data
-===========================================
+-------------------------------------------
 
 First, let's retrieve some financial data. For this example, we'll fetch historical closing prices for a given stock (e.g., `MSFT`):
 
 Import MoabDB and fetch data
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
@@ -52,7 +54,7 @@ Import MoabDB and fetch data
 
 
 Visualizing Data with Matplotlib
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 With our data in hand, we can now plot it:
 
@@ -88,12 +90,12 @@ With our data in hand, we can now plot it:
    
 
 Plotting Multiple Stocks with Daily-Level Data
-==============================================
+----------------------------------------------
 
 First, let's retrieve some financial data. For this example, we'll fetch historical closing prices for a given stock (e.g., `AAPL`):
 
 Import MoabDB and fetch data
-----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
@@ -110,7 +112,7 @@ Import MoabDB and fetch data
 
 
 Visualizing Data with Matplotlib
---------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 With our data in hand, we can now plot it:
 
@@ -147,7 +149,7 @@ With our data in hand, we can now plot it:
    :width: 80%
 
 Plotting Cumulative Returns for Multiple Stocks
-===============================================
+-----------------------------------------------
 
 To visualize the performance of various stocks over time, 
 we'll compute and plot their cumulative returns. Mathematically, the 
@@ -162,7 +164,7 @@ subtracted by 1. This gives us a percentage that we can plot over time.
 
 
 Compute and Visualize Cumulative Returns with Matplotlib
---------------------------------------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 We can easily calculate cumulative return as price `t` divided by 
 the initial price, and then subtracting 1 Let's compute this for our stocks:
