new docs

lsbardel · lsbardel · commit 2ae8dec8d331 · 2026-03-28T18:20:04.000Z
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -17,7 +17,7 @@ jobs:
       COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
 
     steps:
     - uses: actions/checkout@v4
@@ -50,16 +50,14 @@ jobs:
       - build
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.14"
-    - name: Install all dev dependencies
-      run: make install-dev
-    - name: build book
-      run: make book
-    - name: publish book
-      run: make publish-book
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+    - name: Install dependencies
+      run: uv sync --all-extras --group book
+    - name: build docs
+      run: make docs
+    - name: publish docs
+      run: make publish-docs
     - name: publish
       if: ${{ github.ref == 'refs/heads/main' && github.event.head_commit.message == 'release' }}
       run: make publish
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@ build
 docs/build
 htmlcov
 dist
+site
 venv
 MANIFEST
 .python-version
diff --git a/Makefile b/Makefile
@@ -12,10 +12,6 @@ clean:		## Remove python cache files
 	rm -rf .pytest_cache
 	rm -rf .coverage
 
-.PHONY: docs
-docs:		## Build docs
-	cd docs && make docs
-
 .PHONY: install-dev
 install-dev:	## Install packages for development
 	@./dev/install
@@ -36,17 +32,17 @@ test:		## Test with python 3.8 with coverage
 publish:	## Release to pypi
 	@uv build && uv publish --token $(PYPI_TOKEN)
 
-.PHONY: notebook
-notebook:	## Run Jupyter notebook server
-	@uv run ./dev/start-jupyter 9095
+.PHONY: docs
+docs:		## Build mkdocs site
+	uv run mkdocs build
 
-.PHONY: book
-book:		## Build static jupyter {book}
-	uv run jupyter-book build docs --all
+.PHONY: docs-serve
+docs-serve:	## Serve docs locally with live reload
+	uv run mkdocs serve
 
-.PHONY: publish-book
-publish-book:	## Publish the book to github pages
-	uv run ghp-import -n -p -f docs/_build/html
+.PHONY: publish-docs
+publish-docs:	## Publish docs to github pages
+	uv run mkdocs gh-deploy
 
 .PHONY: outdated
 outdated:	## Show outdated packages
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+ccy.quantmind.com
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_toc.yml b/docs/_toc.yml
diff --git a/docs/dates.md b/docs/dates.md
@@ -1,53 +1,26 @@
----
-jupytext:
-  text_representation:
-    extension: .md
-    format_name: myst
-    format_version: 0.13
-    jupytext_version: 1.14.7
-kernelspec:
-  display_name: Python 3 (ipykernel)
-  language: python
-  name: python3
----
-
 # Dates & Periods
 
-The module is shipped with a ``date`` module for manipulating time periods and 
-converting dates between different formats. Th  *period* function can be use 
-to create ``Period`` instanc.::
+The module is shipped with a `date` module for manipulating time periods and
+converting dates between different formats. The *period* function can be used
+to create `Period` instances:
 
-```{code-cell} ipython3
+```python
 import ccy
 p = ccy.period("1m")
 p
 ```
 
-```{code-cell} ipython3
+```python
 p += "2w"
 p
 ```
 
-```{code-cell} ipython3
+```python
 p += "3m"
 p
 ```
 
-```{code-cell} ipython3
-p -= "1w"
-p
-```
-
-```{code-cell} ipython3
-p -= "1w"
-p
-```
-
-```{code-cell} ipython3
+```python
 p -= "1w"
 p
 ```
-
-```{code-cell} ipython3
-
-```
diff --git a/docs/index.md b/docs/index.md
@@ -1,16 +1,3 @@
----
-jupytext:
-  text_representation:
-    extension: .md
-    format_name: myst
-    format_version: 0.13
-    jupytext_version: 1.14.7
-kernelspec:
-  display_name: Python 3 (ipykernel)
-  language: python
-  name: python3
----
-
 # Python CCY
 
 ## Getting Started
@@ -21,7 +8,7 @@ pip install ccy
 ```
 * display currencies
 
-```{code-cell} ipython3
+```python
 import ccy
 import pandas as pd
 df = pd.DataFrame(ccy.dump_currency_table())
@@ -30,78 +17,69 @@ df.head(80)
 
 ## Main Usage
 
-```{code-cell} ipython3
+```python
 import ccy
 eur = ccy.currency("aud")
 eur.printinfo()
 ```
 
 a currency object has the following properties:
-* *code*: the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letters codee.
-* *twoletterscode*: two letter crg.
+* *code*: the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letters code.
+* *twoletterscode*: two letter code.
 * *default_country*: the default [ISO 3166-1 alpha_2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code for the currency.
 * *isonumber*: the ISO 4217 number.
 * *name*: the name of the currency.
 * *order*: default ordering in currency pairs (more of this below).
 * *rounding*: number of decimal places
 
-+++
-
 ## Currency Crosses
 
+You can create currency pairs by using the `currency_pair` function:
 
-You can create currency pairs by using the ``currency_pair`` functn::
-
-```{code-cell} ipython3
+```python
 c = ccy.currency_pair("eurusd")
 c
 ```
 
-```{code-cell} ipython3
+```python
 c.mkt()
 ```
 
-```{code-cell} ipython3
+```python
 c = ccy.currency_pair("chfusd")
-c
-```
-
-```{code-cell} ipython3
 c.mkt()  # market convention pair
 ```
 
 ## cross & crossover
 
 Some shortcuts:
 
-```{code-cell} ipython3
+```python
 ccy.cross("aud")
 ```
 
-```{code-cell} ipython3
+```python
 ccy.crossover('eur')
 ```
 
-```{code-cell} ipython3
+```python
 ccy.crossover('chf')
 ```
 
-```{code-cell} ipython3
+```python
 ccy.crossover('aud')
 ```
 
 Note, the Swiss franc cross is represented as 'USD/CHF', while the Aussie Dollar and Euro crosses are represented with the USD as denominator. This is the market convention which is handled by the order property of a currency object.
 
-+++
-
 ## Eurozone
 
 The euro area, commonly called the eurozone (EZ), is a currency union of 20 member states of the European Union (EU) that have adopted the euro (€) as their primary currency and sole legal tender, and have thus fully implemented EMU policies.
 
-```{code-cell} ipython3
+```python
 ccy.eurozone
 ```
 
-```{code-cell} ipython3
+```python
 ccy.print_eurozone()
 ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,32 @@
+site_name: Python CCY
+site_url: https://ccy.quantmind.com/
+repo_url: https://github.com/quantmind/ccy
+repo_name: quantmind/ccy
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: teal
+      accent: amber
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.footer
+    - navigation.indexes
+    - navigation.path
+    - content.code.copy
+
+nav:
+  - Home: index.md
+  - Dates & Periods: dates.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,19 +34,14 @@ dev = [
     "types-python-dateutil>=2.9.0.20241003",
 ]
 book = [
-    "jupyter-book>=1.0.3",
-    "jupyterlab>=4.3.4",
-    "jupytext>=1.16.6",
-    "ghp-import>=2.1.0",
+    "mkdocs>=1.6",
+    "mkdocs-material>=9.0",
 ]
 
 [build-system]
 requires = [ "hatchling" ]
 build-backend = "hatchling.build"
 
-[tool.jupytext]
-formats = "ipynb,myst"
-
 [tool.isort]
 profile = "black"
 
diff --git a/uv.lock b/uv.lock
