Overhaul documentation (pydata_sphinx_theme) (#432)

* try pydata_sphinx_theme * tidy up conf.py * remove search templates * add citing page * minify svg logos * tidy index.rst * update faq * improve pages * add sphinx_design * add styles * add 404 pages * update build instructions * formatting
raphaelvallat · Sep 3, 2024 · aaae740 · aaae740
1 parent b563de7
commit aaae740
Show file tree

Hide file tree

Showing 17 changed files with 247 additions and 391 deletions.
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,36 @@
+/* -------------------- THEME OVERRIDES -------------------- */
+
+html[data-theme="light"],
+html[data-theme="dark"] {
+  --pst-color-primary: #4583ec;
+  --pst-color-secondary: #d46700;
+  --pst-color-table-row-zebra-low-bg: var(--bs-table-bg);
+  --pst-color-table-row-hover-bg: transparent;
+  --pst-color-inline-code: var(--pst-color-text-base);
+}
+
+html[data-theme="light"] {
+  --pst-color-inline-code-links: #00358f;
+}
+
+html[data-theme="dark"] {
+  --pst-color-inline-code-links: #00caeb;
+}
+
+#pst-back-to-top:hover {
+  background-color: #a95200;
+}
+
+table caption {
+  text-align: left;
+}
+
+/* -------------------- NAV BAR-------------------- */
+
+html[data-theme="dark"] .navbar-brand p {
+  color: white;
+}
+
+html[data-theme="dark"] .navbar-brand img {
+  filter: invert(1);
+}
diff --git a/docs/_static/style.css b/docs/_static/style.css
diff --git a/docs/api.rst b/docs/api.rst
@@ -5,8 +5,6 @@
 Functions
 #########
 
-.. contents:: Table of Contents
-   :depth: 2
 
 ANOVA and T-test
 ----------------

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -3,11 +3,6 @@
 What's new
 ##########
 
-.. contents:: Table of Contents
-    :depth: 2
-
-*************
-
 v0.5.4 (January 2024)
 ---------------------
 

diff --git a/docs/citing.rst b/docs/citing.rst
@@ -0,0 +1,47 @@
+.. _citing:
+
+Citation and logo
+#################
+
+Citing
+******
+
+If you want to cite Pingouin, please use the publication in JOSS:
+
+    Vallat, R. (2018). Pingouin: statistics in Python. *Journal of Open Source Software*, 3(31), 1026, `https://doi.org/10.21105/joss.01026 <https://doi.org/10.21105/joss.01026>`_
+
+Here is a ready-made BibTeX entry:
+
+.. highlight:: none
+
+::
+
+    @article{Vallat2018,
+        title = {Pingouin: statistics in Python},
+        volume = {3},
+        DOI = {10.21105/joss.01026},
+        number = {31},
+        journal = {Journal of Open Source Software},
+        publisher = {The Open Journal},
+        author = {Vallat,  Raphael},
+        year = {2018},
+        month = nov,
+        pages = {1026}
+    }
+
+
+Logo
+****
+
+Wide logo
+=========
+.. figure::  /pictures/logo_pingouin.png
+  :align: left
+  :alt: pingouin logo
+
+Quadratic logo 
+==============
+.. figure::  /pictures/pingouin.png
+  :align: left
+  :alt: pingouin logo quadratic
+