From 6562e9daa76d5f85c2638e3b664058519919c98f Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 13:01:23 +0000 Subject: [PATCH 01/13] Updated links to ArcticDB website and docs Some of the links were not working from GitHub markdown docs, some needed to be updated. --- docs/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.md b/docs/index.md index 8b9af4bb..2a13cca6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,15 +2,15 @@ ## ArcticDB -[ArcticDB](https://www.man.com/man-group-brings-powerful-dataframe-database-product-arcticdb-to-market-with-bloomberg), Man Group's high-performance Python-native +[ArcticDB](https://arcticdb.io/), Man Group's high-performance Python-native DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). ArcticDB is the next generation of Arctic and is designed to be a drop-in replacement for it. These docs **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. -The docs for ArcticDB are available [here](docs.arcticdb.io). +The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/). -If you would like information on ArcticDB please see the [website](arcticdb.io). +If you would like information on ArcticDB please see the [website](https://arcticdb.io/). The rest of these docs describe the first-generation Arctic platform. From 6a84e3cdd9f0cb034c864f6e76ac7449909b7363 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 13:49:12 +0000 Subject: [PATCH 02/13] Remove requirements.txt versions as they cause docs build to fail --- docs/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 4bba0c6e..8c66ee9b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -jinja2==3.0.0 -Markdown<3.2 -mkdocs>=1.2.3 +jinja2 +Markdown +mkdocs From 378b09a308df77400792f55b8cf287768308745b Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 14:16:45 +0000 Subject: [PATCH 03/13] Empty commit (needed to start the docs-build) From 6a031b19c56347870f8b5d921b1bb087b868ffbe Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 14:22:23 +0000 Subject: [PATCH 04/13] Empty commit (needed to start the docs-build) From 02bb8821d943d032f73b12955abdd77e62afe348 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 14:41:17 +0000 Subject: [PATCH 05/13] Empty commit (needed to start the docs-build) From e7a04ac7a9cd1991e4460e0fa87cb42d683304f3 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 14:44:15 +0000 Subject: [PATCH 06/13] Empty commit (needed to start the docs-build) From 2500889a30ed587315a8e632e6e16ba03b32c83a Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Tue, 16 Jan 2024 17:45:00 +0000 Subject: [PATCH 07/13] Added #arctic1 for tracking traffic --- docs/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 2a13cca6..3196f8bc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,15 +2,15 @@ ## ArcticDB -[ArcticDB](https://arcticdb.io/), Man Group's high-performance Python-native +[ArcticDB](https://arcticdb.io/#arctic1), Man Group's high-performance Python-native DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). ArcticDB is the next generation of Arctic and is designed to be a drop-in replacement for it. -These docs **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. -The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/). +The docs below **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. +The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/#arctic1). -If you would like information on ArcticDB please see the [website](https://arcticdb.io/). +If you would like information on ArcticDB please see the [website](https://arcticdb.io/#arctic1). The rest of these docs describe the first-generation Arctic platform. From ab9d769d1c0013f9cedd104ec568aeeb3fbcde62 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 09:44:40 +0000 Subject: [PATCH 08/13] Add a tip to show arcticdb link --- .readthedocs.yaml | 6 ++++++ docs/index.md | 19 +++++++++---------- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dd3038f6..36e41438 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,3 +14,9 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: false +myst enable extensions: +- colon_fence +- deflist +- dollarmath +myst_heading_anchors: 2 +myst_highlight_code_blocks: true diff --git a/docs/index.md b/docs/index.md index 3196f8bc..5447062f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,18 +1,17 @@ -# Arctic Introduction - -## ArcticDB +.. tip:: + [ArcticDB](https://arcticdb.io/#arctic1), Man Group's high-performance Python-native + DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). -[ArcticDB](https://arcticdb.io/#arctic1), Man Group's high-performance Python-native -DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). + ArcticDB is the next generation of Arctic and is designed to be a drop-in replacement for it. -ArcticDB is the next generation of Arctic and is designed to be a drop-in replacement for it. + The docs below **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. + The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/#arctic1). -The docs below **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. -The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/#arctic1). + If you would like information on ArcticDB please see the [website](https://arcticdb.io/#arctic1). -If you would like information on ArcticDB please see the [website](https://arcticdb.io/#arctic1). + The rest of these docs describe the first-generation Arctic platform. -The rest of these docs describe the first-generation Arctic platform. +# Arctic Introduction ## Arctic From 618407c46ad789494a9028bfd4aee6d57ddec346 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 09:46:11 +0000 Subject: [PATCH 09/13] correct myst extension inclusion --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 36e41438..485ba42a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,7 +14,7 @@ mkdocs: configuration: mkdocs.yml fail_on_warning: false -myst enable extensions: +myst_enable_extensions: - colon_fence - deflist - dollarmath From e10796e825550da51169023ceba468f6fb1ba624 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 09:49:41 +0000 Subject: [PATCH 10/13] remove inclusions --- .readthedocs.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 485ba42a..57c30d87 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,10 +13,3 @@ python: mkdocs: configuration: mkdocs.yml fail_on_warning: false - -myst_enable_extensions: -- colon_fence -- deflist -- dollarmath -myst_heading_anchors: 2 -myst_highlight_code_blocks: true From f9ffa66d6aabe6c953471fad7e8dbae8bd04fadf Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 09:53:03 +0000 Subject: [PATCH 11/13] Trying backtick for the box --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5447062f..65b82549 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -.. tip:: +```{tip} [ArcticDB](https://arcticdb.io/#arctic1), Man Group's high-performance Python-native DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). @@ -10,7 +10,7 @@ If you would like information on ArcticDB please see the [website](https://arcticdb.io/#arctic1). The rest of these docs describe the first-generation Arctic platform. - +``` # Arctic Introduction ## Arctic From 268f1ad1791bc87500916543d87e886abf5b9a90 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 10:36:23 +0000 Subject: [PATCH 12/13] Add admonitions to mkdocs and use git status! notation --- docs/index.md | 19 ++++++++----------- mkdocs.yml | 3 +++ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/index.md b/docs/index.md index 65b82549..d7ca4f66 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,13 @@ -```{tip} - [ArcticDB](https://arcticdb.io/#arctic1), Man Group's high-performance Python-native - DataFrame database is available on [GitHub](https://github.com/man-group/arcticdb). +!!! important "Important" + ## ArcticDB - ArcticDB is the next generation of Arctic and is designed to be a drop-in replacement for it. + [ArcticDB](https://arcticdb.io/#arctic1) is a ground-up rewrite of Arctic.
+ The old Arctic, described below, is in maintenance mode.
+ ArcticDB uses a very similar api to Arctic and is much faster. + + Take a look:
+ [Website](https://arcticdb.io/#arctic1), [Docs](https://docs.arcticdb.io/latest/#arctic1), [GitHub](https://github.com/man-group/arcticdb) - The docs below **do not describe ArcticDB**, but instead the older (first) version of the Arctic platform. - The docs for ArcticDB are available [here](https://docs.arcticdb.io/latest/#arctic1). - - If you would like information on ArcticDB please see the [website](https://arcticdb.io/#arctic1). - - The rest of these docs describe the first-generation Arctic platform. -``` # Arctic Introduction ## Arctic diff --git a/mkdocs.yml b/mkdocs.yml index 8aaf6042..0b2edb0a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,9 @@ repo_name: 'arctic' repo_url: 'https://github.com/man-group/arctic' edit_uri: edit/master/docs/ +markdown_extensions: + - admonition + theme: name: 'readthedocs' From 1c308bc3855b7c0a04b5f15530b942e5ebb10160 Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Sajjad Date: Wed, 17 Jan 2024 10:42:41 +0000 Subject: [PATCH 13/13] extra line add to leave as before --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 57c30d87..dd3038f6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,3 +13,4 @@ python: mkdocs: configuration: mkdocs.yml fail_on_warning: false +