From 993c75103b7fccebb33dc0a148a4b9be42373d54 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Tue, 18 Jun 2024 09:04:59 +0200 Subject: [PATCH 1/2] Generate social cards in Sphinx documentation Without `matplotlib` installed, Sphinx output says that social cards cannot be generated. --- requirements/docs.pip | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements/docs.pip b/requirements/docs.pip index 7b0f37cc..4c16c84a 100644 --- a/requirements/docs.pip +++ b/requirements/docs.pip @@ -2,4 +2,5 @@ sphinx sphinxext-opengraph furo==2023.9.10 livereload +matplotlib tomli;python_version<"3.11" From 49723e6daf8caf6c46ab6cb58715dfe6b7e4a40d Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Tue, 18 Jun 2024 09:08:45 +0200 Subject: [PATCH 2/2] Docs: Remove `ifconfig` Sphinx extension Originally added in #815, something about this seems to be causing an obscure ReadTheDocs build error. --- docs/conf.py | 1 - docs/index.rst | 9 --------- 2 files changed, 10 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8f14a018..b812ee4c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,6 @@ with open("../pyproject.toml", "rb") as f: templates_path = ["_templates"] extensions = [ "sphinx.ext.autodoc", - "sphinx.ext.ifconfig", "sphinx.ext.extlinks", "sphinxext.opengraph", ] diff --git a/docs/index.rst b/docs/index.rst index 60591482..159ea3be 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,15 +1,6 @@ Pelican |release| ================= - -.. ifconfig:: release.endswith('.dev') - - .. warning:: - - This documentation is for the version of Pelican currently under - development. Were you looking for version |last_stable| documentation? - - Pelican is a static site generator, written in Python_. Highlights include: * Write your content directly with your editor of choice in reStructuredText_