Update to pydata_sphinx_theme and blog

PhilipMay · Dec 7, 2023 · e4ce6e0 · e4ce6e0
1 parent 09f1241
commit e4ce6e0
Show file tree

Hide file tree

Showing 18 changed files with 298 additions and 264 deletions.
diff --git a/Makefile b/Makefile
@@ -16,6 +16,7 @@ help:
 
 format:
 	mdformat --number .
+	black source
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,3 @@
+[tool.black]
+line-length = 99
+target-version = ["py310"]
diff --git a/requirements.txt b/requirements.txt
@@ -1,8 +1,9 @@
 sphinx
 myst-parser
-sphinx-book-theme
+pydata-sphinx-theme
 myst-nb
 mdformat
 sphinx-design
 sphinx-copybutton
 ablog
+black[jupyter]
diff --git a/source/_static/img/date-encoding.png b/source/_static/img/date-encoding.png
diff --git a/source/blog.md b/source/blog.md
@@ -1,9 +1 @@
 # Blog
-
-```{toctree}
-:glob:
-:titlesonly:
-:reversed:
-
-blog/*
-```
diff --git a/source/blog/2020-12-01-electra-train-eval.md → source/blog/2020/electra-train-eval.md b/source/blog/2020-12-01-electra-train-eval.md → source/blog/2020/electra-train-eval.md
@@ -10,5 +10,5 @@ We tell what is done differently with our model or the tokenizer than with other
 explain the composition of our text corpus and illustrate the evaluation and
 comparison of the language model.
 
-[Slides](../_static/doc/German_Language_Model_Training_and_Evaluation.pdf) and
+[Slides](/_static/doc/German_Language_Model_Training_and_Evaluation.pdf) and
 [YouTube video](https://www.youtube.com/watch?v=cxgrTd2AQis) are available:
diff --git a/source/blog/2021-04-10-gc4-release.md → source/blog/2021/gc4-release.md b/source/blog/2021-04-10-gc4-release.md → source/blog/2021/gc4-release.md
diff --git a/source/blog/2022-10-12-date-encoding.md → source/blog/2022/date-encoding.md b/source/blog/2022-10-12-date-encoding.md → source/blog/2022/date-encoding.md
@@ -5,6 +5,12 @@
 
 Some data, such as strings, must be encoded to be used in machine learning models. Here we explore the different options for encoding date fields.
 
+:::{figure} /\_static/img/date-encoding.png
+:width: 550px
+
+Date encoding
+:::
+
 The general options to encode the time dimension like the birth date of a customer or the production time of a product are:
 
 1. separate encoding of year, month and maybe also day and weekday

diff --git a/...02-22-german-wikipedia-corpus-released.md → .../2022/german-wikipedia-corpus-released.md b/...02-22-german-wikipedia-corpus-released.md → .../2022/german-wikipedia-corpus-released.md
@@ -5,8 +5,8 @@
 
 Today I published a new Wikipedia-based German text corpus. It is to be used for NLP machine learning tasks.
 
-:::{figure} ../\_static/img/wikipedia.png
-:width: 50 %
+:::{figure} /\_static/img/wikipedia.png
+:width: 550px
 
 Wikipedia
 :::

diff --git a/...e/blog/2022-02-20-lightgbm-optuna-demo.md → source/blog/2022/lightgbm-optuna-demo.md b/...e/blog/2022-02-20-lightgbm-optuna-demo.md → source/blog/2022/lightgbm-optuna-demo.md
@@ -7,8 +7,8 @@ This week I published a project to show how to combine
 LightGBM and Optuna efficiently to train good models.
 The purpose of this work is to be able to be reused as a template for new projects.
 
-:::{figure} ../\_static/img/lightgbm-optuna.png
-:width: 50 %
+:::{figure} /\_static/img/lightgbm-optuna.png
+:width: 550px
 
 LightGBM & Optuna
 :::

diff --git a/source/blog/2022-02-23-mlsum-anomalies.md → source/blog/2022/mlsum-anomalies.md b/source/blog/2022-02-23-mlsum-anomalies.md → source/blog/2022/mlsum-anomalies.md
@@ -8,8 +8,8 @@ my colleague [Michal Harakal](https://www.harakal.de/) and I noticed that in man
 sentence of the input text.
 Instead, it should generate an independent summary of the whole text.
 
-:::{figure} ../\_static/img/text-unsplash.jpg
-:width: 50 %
+:::{figure} /\_static/img/text-unsplash.jpg
+:width: 550px
 
 Photo by [Sandy Millar](https://unsplash.com/@sandym10?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash) on [Unsplash](https://unsplash.com/photos/a-close-up-of-a-book-with-some-type-of-text-Kl4LNdg6on4?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash)
 :::

diff --git a/source/blog/2022-07-23-python-conda-pip.md → source/blog/2022/python-conda-pip.md b/source/blog/2022-07-23-python-conda-pip.md → source/blog/2022/python-conda-pip.md
diff --git a/source/blog/2023-11-18-Pandas-apply.ipynb → source/blog/2023/pandas-apply.ipynb b/source/blog/2023-11-18-Pandas-apply.ipynb → source/blog/2023/pandas-apply.ipynb
diff --git a/source/conf.py b/source/conf.py
@@ -8,7 +8,7 @@
 
 project = "May.la"
 html_title = "May.la"
-copyright = "2023, Philip May"
+copyright = "2020 - 2023, Philip May"
 author = "Philip May"
 
 # -- General configuration ---------------------------------------------------
@@ -22,7 +22,7 @@
     "ablog",  # https://ablog.readthedocs.io/
 ]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
 
 # implicit link header targets
@@ -32,25 +32,45 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# https://github.com/executablebooks/sphinx-book-theme
-# https://sphinx-book-theme.readthedocs.io/
-html_theme = 'sphinx_book_theme'
+# https://pydata-sphinx-theme.readthedocs.io/
+html_theme = "pydata_sphinx_theme"
 
+html_sidebars = {
+    "index": ["sidebar-nav-bs"],
+    "blog": [
+        "ablog/postcard.html",
+        "ablog/recentposts.html",
+        "ablog/tagcloud.html",
+        "ablog/categories.html",
+        "ablog/archives.html",
+    ],
+    "blog/**": [
+        "ablog/postcard.html",
+        "ablog/recentposts.html",
+        "ablog/tagcloud.html",
+        "ablog/categories.html",
+        "ablog/archives.html",
+    ],
+}
+
+#
 html_theme_options = {
-    # "home_page_in_toc": True,
-    # "github_url": "https://github.com/PhilipMay/may-la-myst",
-    "repository_url": "https://github.com/PhilipMay/may-la-myst",
-    "repository_branch": "main",
-    "path_to_docs": "source",
-    "use_repository_button": True,
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/header-links.html#navigation-bar-dropdown-links
+    "header_links_before_dropdown": 6,
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#hide-the-previous-and-next-buttons
+    "show_prev_next": False,
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/search.html#configure-the-search-bar-text
+    "search_bar_text": "Search this site...",
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html#add-an-edit-button
     "use_edit_page_button": True,
-    "use_issues_button": True,
-    # "announcement": "<b>v2.0.0</b> is now out! See the Changelog for details",
+    # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#footer
+    "footer_start": ["copyright"],
+    "footer_end": [],
 }
 
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-html_extra_path = ['_extra']
+html_extra_path = ["_extra"]
 
 # https://myst-nb.readthedocs.io/en/latest/computation/execute.html
 nb_execution_mode = "off"
@@ -74,7 +94,16 @@
 
 # Blog config https://ablog.readthedocs.io/en/stable/manual/ablog-configuration-options.html
 blog_authors = {
-    'PhilipMay': ('Philip May', 'http://may.la'),
+    "PhilipMay": ("Philip May", "http://may.la"),
 }
 
-blog_default_author='PhilipMay'
+# https://ablog.readthedocs.io/en/stable/manual/ablog-configuration-options.html#confval-blog_default_author
+blog_default_author = "PhilipMay"
+
+# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html#github
+html_context = {
+    "github_user": "PhilipMay",
+    "github_repo": "may-la-myst",
+    "github_version": "main",
+    "doc_path": "source",
+}