From 47acd0d60076a6d17b69322f4b6f4d8d02d2670c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Hatcher?= Date: Wed, 27 Nov 2024 22:20:18 +0100 Subject: [PATCH] FIX: Some fixes to the doumentation --- docs/src/.vitepress/config.mts | 4 ++++ docs/src/.vitepress/theme/style.css | 12 ++++++------ docs/src/programming/about.md | 11 +++++++++++ docs/src/programming/python-bindings.md | 2 ++ docs/src/programming/rust.md | 2 ++ 5 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 docs/src/programming/about.md diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index 4f22bba..7934ec7 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -1990,6 +1990,10 @@ export default defineConfig({ text: "Programming", collapsed: true, items: [ + { + text: "About", + link: "/programming/about", + }, { text: "Rust", link: "/programming/rust", diff --git a/docs/src/.vitepress/theme/style.css b/docs/src/.vitepress/theme/style.css index 1646dc9..f2dd662 100644 --- a/docs/src/.vitepress/theme/style.css +++ b/docs/src/.vitepress/theme/style.css @@ -175,20 +175,20 @@ li::marker { top: 36px; } -.VPSwitch[data-v-70a26bb8] { - background-color: var(--vp-c-bg-alt); +.VPSwitch { + background-color: var(--vp-c-bg-alt) !important; } -.VPDocFooter[data-v-29ec59c0] { - margin-top: 36px; +.VPDocFooter { + margin-top: 36px !important; } table { width: 100%; } -.VPSidebarItem.level-0[data-v-3db96182] { - padding-bottom: 10px; +.VPSidebarItem.level-0 { + padding-bottom: 10px !important; } .VPBadge.info { diff --git a/docs/src/programming/about.md b/docs/src/programming/about.md new file mode 100644 index 0000000..475c30b --- /dev/null +++ b/docs/src/programming/about.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Programming IronCalc + +IronCal is a spreadsheet _engine_ first. This means you can load the engine from a myriad of places. The very same computational engine tat you use in the [browser](https://app.ironcalc.com) you can use from your favourite programming language. + +Using IronCalc programmatically means you can create spreadsheets on the fly. Maybe you want to create reports for your users or maybe you want to run the spreadsheet with a series of inputs and use the outputs. diff --git a/docs/src/programming/python-bindings.md b/docs/src/programming/python-bindings.md index ae5773e..e480073 100644 --- a/docs/src/programming/python-bindings.md +++ b/docs/src/programming/python-bindings.md @@ -6,6 +6,8 @@ lang: en-US # Python Bindings +The Python documentation for IronCalc might be found [here](https://ironcalc.readthedocs.io/en/latest/) + ::: warning **Note:** This page is in construction 🚧 ::: diff --git a/docs/src/programming/rust.md b/docs/src/programming/rust.md index 947ae73..095c4ab 100644 --- a/docs/src/programming/rust.md +++ b/docs/src/programming/rust.md @@ -6,6 +6,8 @@ lang: en-US # Rust +The Rust API documentation might be found [here](https://docs.rs/ironcalc/latest/ironcalc/) + ::: warning **Note:** This page is in construction 🚧 :::