From b0c5115b05af0aed8799e843273d72b0e10868a4 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:04:51 +0200 Subject: [PATCH 1/8] add plugins search and bamboo to the available framework --- mkdocs.yml | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index be4b1f5..679a1ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ nav: - Doxygen: doxyfwk/index.html - GridIn: gridin.md - plotIt: plotit.md + - Bamboo: bamboo.md # Extensions markdown_extensions: @@ -27,6 +28,9 @@ markdown_extensions: plugins: - markdownextradata + - search + # - git-revision-date-localized: + # enable_creation_date: true - doxygen: tryclone: true packages: @@ -34,16 +38,36 @@ plugins: url : https://github.com/cp3-llbb/Framework.git config : docs/doxygen.cfg -# Theming +# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color theme: - name: 'material' + name: material language: 'en' palette: - primary: 'indigo' - accent: 'indigo' + - scheme: default + primary: deep purple + accent: deep purple + toggle: + icon: material/weather-night + name: Switch to dark mode + - scheme: slate + primary: 'indigo' + accent: 'indigo' + toggle: + icon: material/weather-sunny + name: Switch to light mode font: text: 'Roboto' code: 'Roboto Mono' + features: + - header.autohide + - navigation.footer + - content.action.edit + - content.action.view + - content.code.copy + - search.highlight + - search.share + - search.suggest + - toc.follow extra: social: From 769de6d83b1508f43a1c116a9cf707b399403904 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:08:55 +0200 Subject: [PATCH 2/8] Create bamboo.md --- docs/bamboo.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/bamboo.md diff --git a/docs/bamboo.md b/docs/bamboo.md new file mode 100644 index 0000000..324c332 --- /dev/null +++ b/docs/bamboo.md @@ -0,0 +1,4 @@ +# Bamboo: A high-level HEP analysis library for ROOT::RDataFrame +You can find out more about bamboo in the UserGuide: https://bamboo-hep.readthedocs.io/en/latest/. +Also feel free to report any issue you encounter in [~bamboo channel](https://mattermost.web.cern.ch/cms-exp/channels/bamboo) on the CERN mattermost, or on [Gitlab](https://gitlab.cern.ch/cms-analysis/general/bamboo/-/issues). + From 3d2e6f02334e5b95840127bfda8cc223bd261ad3 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:14:03 +0200 Subject: [PATCH 3/8] add the default value to y-axis-format --- docs/plotit.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/plotit.md b/docs/plotit.md index 8c4d164..4dab8d0 100644 --- a/docs/plotit.md +++ b/docs/plotit.md @@ -133,9 +133,9 @@ There are also a number of optional arguments that change the behaviour: | exclude | string | Regexp allowing to exlude histograms present in the files whose name matches the plot's name | | | x-axis | string | x-axis title | | | y-axis | string | y-axis title | `Events` | -| y-axis-format | formatted string | Overrides plotIt option. | | +| y-axis-format | formatted string | Overrides plotIt option. | %1% | | normalized | bool | Normalize data/each signal/total MC to 1. | `false` | -| normalizedByBinWidth| bool | The bin contents and errors are divided by the bin width. | `false` | +| normalizedByBinWidth | bool | The bin contents and errors are divided by the bin width. | `false` | | no-data | bool | Do not plot data. | `false` | | override | bool | If any plot has this field set to true, only plots which do will be produced. | `false` | | log-y | bool | Log-scale on y-axis. Special value: `Both`. | `false` | From a9bebd4d235696df4883750e25b8d5fc25df3c35 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:30:56 +0200 Subject: [PATCH 4/8] Fix import of Sequence for Python 3.10+ compatibility --- requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 98c8a31..b3dc7a8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,5 @@ mkdocs-material Pygments pymdown-extensions mkdocs-markdownextradata-plugin -git+https://github.com/pieterdavid/mkdocs-doxygen-plugin.git#egg=mkdocs-doxygen-plugin +git+https://github.com/kjaffel/mkdocs-doxygen-plugin.git#egg=mkdocs-doxygen-plugin + From e94985e73059a0e3537f0df730888c9336b9ca01 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:32:44 +0200 Subject: [PATCH 5/8] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b68875e..d80bc81 100644 --- a/README.md +++ b/README.md @@ -1 +1,2 @@ -CP3-llbb Analysis Tools documentation, see [https://cp3-llbb.github.io](https://cp3-llbb.github.io) +# CP3-llbb Analysis Tools documentation: +You can find the documentation at: [https://cp3-llbb.github.io](https://cp3-llbb.github.io) From 256e9181baff4392e78a9fea8891d0cc53a4d85f Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 15:43:41 +0200 Subject: [PATCH 6/8] Update mkdocs.yml --- mkdocs.yml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 679a1ea..9e3bc6c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,15 +40,9 @@ plugins: # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color theme: - name: material + name: 'material' language: 'en' palette: - - scheme: default - primary: deep purple - accent: deep purple - toggle: - icon: material/weather-night - name: Switch to dark mode - scheme: slate primary: 'indigo' accent: 'indigo' From 6b40adaa12ebace38e810b8e25dec07ed8d79ede Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 16:17:36 +0200 Subject: [PATCH 7/8] fix toggle between dark and light mode --- mkdocs.yml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 9e3bc6c..39d8140 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,10 +42,16 @@ plugins: theme: name: 'material' language: 'en' - palette: + palette: + - scheme: default + primary: 'indigo' + accent: d'indigo' + toggle: + icon: material/weather-night + name: Switch to dark mode - scheme: slate primary: 'indigo' - accent: 'indigo' + accent: 'indigo' toggle: icon: material/weather-sunny name: Switch to light mode From d9cf5b64abb0bd10cbb3e128eebad1e16ef840d2 Mon Sep 17 00:00:00 2001 From: Khawla Jaffel <47111455+kjaffel@users.noreply.github.com> Date: Wed, 14 Aug 2024 16:22:36 +0200 Subject: [PATCH 8/8] Update mkdocs.yml fix typos --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 39d8140..fd7f76c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -42,10 +42,10 @@ plugins: theme: name: 'material' language: 'en' - palette: + palette: - scheme: default primary: 'indigo' - accent: d'indigo' + accent: 'indigo' toggle: icon: material/weather-night name: Switch to dark mode