Merge pull request #7 from kjaffel/source

Fix mkdocs build

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)

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).
+

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` |

mkdocs.yml

@@ -14,6 +14,7 @@ nav:
     - Doxygen: doxyfwk/index.html
   - GridIn: gridin.md
   - plotIt: plotit.md
+  - Bamboo: bamboo.md
 
 # Extensions
 markdown_extensions:
@@ -27,23 +28,46 @@ markdown_extensions:
 
 plugins:
   - markdownextradata
+  - search
+  #  - git-revision-date-localized:
+  #  enable_creation_date: true
   - doxygen:
       tryclone: true
       packages:
         - doxyfwk:
             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'
   language: 'en'
   palette:
-    primary: 'indigo'
-    accent: 'indigo'
+    - scheme: default
+      primary: 'indigo'
+      accent: 'indigo'
+      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:

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
+