Merge pull request #112 from Nixtla/feat/Documentation

FEAT: Documentation Outline
Nixtla · Nov 24, 2022 · f292b1c · f292b1c
2 parents 68e46be + 6617489
commit f292b1c
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 13 deletions.
diff --git a/nbs/_quarto.yml b/nbs/_quarto.yml
@@ -4,17 +4,51 @@ project:
 format:
   html:
     theme: cosmo
+    fontsize: 1em
+    linestretch: 1.7
     css: styles.css
     toc: true
 
 website:
   twitter-card: true
   open-graph: true
+  google-analytics: "G-NXJNCVR18L"
   repo-actions: [issue]
+  favicon: favicon_png.png
   navbar:
     background: primary
     search: true
+    collapse-below: lg
+    left:
+      - text: "Get Started"
+        href: examples/Getting_Started_short.ipynb
+      - text: "NixtlaVerse"
+        menu:
+          - text: "MLForecast 🤖"
+            href: https://github.com/nixtla/mlforecast
+          - text: "NeuralForecast 🧠"
+            href: https://github.com/nixtla/neuralforecast
+          - text: "StatsForecast ⚡️"
+            href: https://github.com/nixtla/neuralforecast
+
+      - text: "Help"
+        menu:
+          - text: "Report an Issue"
+            icon: bug
+            href: https://github.com/nixtla/hierarchicalforecast/issues/new/choose
+          - text: "Join our Slack"
+            icon: chat-right-text
+            href: https://join.slack.com/t/nixtlacommunity/shared_invite/zt-1kd5m5db7-7OOfy0xVNf1PcvCiAPWvPw
+    right:
+      - icon: github
+        href: "https://github.com/nixtla/hierachicalforecast"
+      - icon: twitter
+        href: https://twitter.com/nixtlainc
+        aria-label: Nixtla Twitter
+
   sidebar:
     style: floating
+  body-footer: |
+    If you find the code useful, please ⭐ us on [Github](https://github.com/nixtla/hierachicalforecast)
 
-metadata-files: [nbdev.yml, sidebar.yml]
+metadata-files: [nbdev.yml, sidebar.yml]
diff --git a/nbs/sidebar.yml b/nbs/sidebar.yml
@@ -1,23 +1,34 @@
 website:
   sidebar:
+    collapse-level: 1
     contents:
       - index.ipynb
-      - section: Reference
-        contents:
-        - core.ipynb
-        - methods.ipynb
-        - probabilistic_methods.ipynb
-        - evaluation.ipynb
-        - utils.ipynb
+      - text: "--"
+      - section: "Getting Started"
+        contents: 
+        - examples/Installation.ipynb
+        - examples/TourismSmall.ipynb
+        - examples/Introduction.ipynb
       - section: Tutorials
         contents:
-        - examples/Introduction.ipynb
-        - examples/TourismSmall.ipynb
-        - examples/AustralianDomesticTourism.ipynb
-        - examples/AustralianPrisonPopulation.ipynb
-        - examples/NonNegativeReconciliation.ipynb
+        - section: Point Reconciliation
+          contents:
+          - examples/AustralianDomesticTourism.ipynb
+          - examples/AustralianPrisonPopulation.ipynb
+          - examples/NonNegativeReconciliation.ipynb
         - section: Probabilistic Reconciliation
           contents:
           - examples/AustralianDomesticTourism-Intervals.ipynb
           - examples/AustralianDomesticTourism-Bootstraped-Intervals.ipynb
           - examples/AustralianDomesticTourism-Permbu-Intervals.ipynb
+      - Methods
+      - section: API Reference
+        contents:
+        - core.ipynb
+        - methods.ipynb
+        - probabilistic_methods.ipynb
+        - evaluation.ipynb
+        - utils.ipynb
+      - section: Community
+        contents:
+          - Contributing
diff --git a/nbs/styles.css b/nbs/styles.css
@@ -35,3 +35,23 @@ div.description {
   font-size: 135%;
   opacity: 70%;
 }
+
+/* show_doc signature */
+blockquote > pre {
+  font-size: 14px;
+}
+
+.table {
+  font-size: 16px;
+  /* disable striped tables */
+  --bs-table-striped-bg: var(--bs-table-bg);
+}
+
+.quarto-figure-center > figure > figcaption {
+  text-align: center;
+}
+
+.figure-caption {
+  font-size: 75%;
+  font-style: italic;
+}