Code refactoring

Author: andrewmurphy353

curo/calculator.py

@@ -61,7 +61,7 @@ class Calculator:
         Calculator: A new Calculator instance configured with the specified precision
             and optional profile.
     """
-    def __init__(self, precision: int = 2, profile: Optional[pd.DataFrame] = None):
+    def __init__(self, precision: int = 2, profile: Optional[pd.DataFrame] = None) -> "Calculator":
         if not 0 <= precision <= 4:
             raise ValidationError("Precision must be between 0 and 4")
         self.precision = precision

curo/daycount/__init__.py

@@ -0,0 +1,3 @@
+
+
+::: curo.daycount.actual_360.Actual360

docs/api/daycount/actual_360.md

@@ -0,0 +1,4 @@
+
+
+
+::: curo.daycount.actual_365.Actual365

docs/api/daycount/actual_365.md

@@ -0,0 +1,3 @@
+# API Reference
+
+::: curo.calculator.Calculator

docs/calculator.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/examples.md

@@ -0,0 +1,21 @@
+site_name: Curo Documentation
+theme:
+  name: material
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: true
+            heading_level: 2
+            members_order: source
+            docstring_style: google  # Alt is numpy
+          paths: ["curo"]
+nav:
+  - index.md
+  - Examples: examples.md
+  - API Reference:
+      - Calculator: calculator.md
+      - Daycount Conventions:
+          - Actual/360: api/daycount/actual_360.md
+          - Actual/365: api/daycount/actual_365.md

docs/index.md

@@ -34,6 +34,10 @@ dev = [
     "coverage>=7.13.0",
     "twine>=6.2.0",  # Required for makefile
     "toml>=0.10.2",  # Required for scripts/extract_version.py
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.7.1",
+    "mkdocstrings>=1.0.0",
+    "mkdocstrings-python>=2.0.1",
 ]
 
 [build-system]