Added docs

Author: domokane

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Docs
+
+on:
+  push:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install docs deps
+        run: |
+          python -m pip install -U pip
+          pip install -e . --no-deps
+          pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-jupyter
+
+      - name: Build docs
+        run: mkdocs build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

MANIFEST,in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include financepy/data *.npz

mkdocs.yml

@@ -1,11 +1,63 @@
-site_name: financepy
+site_name: FinancePy
+site_description: "A Finance Securities Valuation Library"
+site_author: "Dominic O'Kane"
+repo_url: https://github.com/domokane/FinancePy
+repo_name: FinancePy
+edit_uri: ""
 
 theme:
-  name: readthedocs
+  name: material
+  logo: images/logo.png   # optional if you have a logo
+  favicon: images/favicon.png
+  palette:
+    - scheme: default
+      primary: blue
+      accent: cyan
+    - scheme: slate
+      primary: blue
+      accent: cyan
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+
+nav:
+  - Home: index.md
+  - Quick Start: quickstart.md
+  - Tutorials:
+      - Bonds: tutorials/bonds.md
+      - Options: tutorials/options.md
+      - Credit: tutorials/credit.md
+  - API Reference:
+      - Products: api/products.md
+      - Models: api/models.md
+      - Markets: api/markets.md
+      - Utils: api/utils.md
+  - Examples: examples.md
+  - About: about.md
+
+markdown_extensions:
+  - admonition
+  - codehilite
+  - footnotes
+  - meta
+  - toc:
+      permalink: true
 
 plugins:
-- search  
-- mkdocstrings
-- gen-files:
-    scripts:
-    - docs/generate.py  
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: true
+            heading_level: 2
+            docstring_style: google
+  - mkdocs-jupyter:
+      execute: false   # set true if you want notebooks auto-executed
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/domokane/FinancePy
+    - icon: fontawesome/brands/python
+      link: https://pypi.org/project/financepy/