Merge pull request #546 from plone/rtd-preview

Remove Netlify stuff, follow up to #545
plone · Jan 8, 2025 · dbb5595 · dbb5595
2 parents ae38e69 + c92b7c8
commit dbb5595
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 24 deletions.
diff --git a/.meta.toml b/.meta.toml
@@ -12,14 +12,15 @@ codespell_extra_lines = """
 
 [pyproject]
 check_manifest_ignores = """
-    ".editorconfig",
+    # From `.meta.toml`, pyproject.check_manifest_ignores.
     "*.cfg",
+    ".editorconfig",
+    ".readthedocs.yaml",
     "constraints_plone52.txt",
     "constraints_plone60.txt",
     "constraints.txt",
     "fix-converted-myst.py",
     "Makefile",
-    "netlify.toml",
     "requirements-docs.txt",
     "requirements.txt",
 """
@@ -77,7 +78,7 @@ allowlist_externals =
     echo
 
 [testenv:plone6docs]
-# New docs with sphinx-book-theme
+# New docs with plone-sphinx-theme
 # See [testenv:docs] for classic documentation
 basepython = python3.11
 skip_install = False
@@ -93,6 +94,18 @@ commands =
     mkdir -p {toxinidir}/_build/plone6docs
     sphinx-build -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html
 
+[testenv:rtd-preview]
+# Build docs on Read the Docs to preview pull requests using plone-sphinx-theme
+basepython = python3.11
+skip_install = False
+extras =
+    tests
+deps =
+    -r requirements-docs.txt
+commands =
+    python -VV
+    sphinx-build -b html -d "{env:READTHEDOCS_OUTPUT}"/doctrees/ docs "{env:READTHEDOCS_OUTPUT}"/html/
+
 [testenv:docs]
 basepython = python3.9
 skip_install = False
@@ -127,6 +140,21 @@ commands =
     python -VV
     mkdir -p {toxinidir}/_build/plone6docs
     sphinx-build -b linkcheck -d _build/plone6docs/doctrees docs _build/plone6docs/linkcheck
+
+[testenv:livehtml]
+basepython = python3.11
+skip_install = False
+package = editable
+allowlist_externals =
+    mkdir
+extras =
+    {[testenv:plone6docs]extras}
+deps =
+    {[testenv:plone6docs]deps}
+commands =
+    python -VV
+    mkdir -p {toxinidir}/_build/plone6docs
+    sphinx-autobuild -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html
 """
 
 [github]

diff --git a/docs/conf.py b/docs/conf.py
@@ -24,6 +24,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
+    "sphinx_copybutton",
 ]
 master_doc = "index"
 
@@ -82,7 +83,7 @@ def __getattr__(cls, name):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_book_theme"
+html_theme = "plone_sphinx_theme"
 
 
 # -- Intersphinx configuration ----------------------------------

diff --git a/docs/contribute.md b/docs/contribute.md
@@ -121,6 +121,12 @@ Alternatively, you can automatically reload changes to the documentation as you
 tox -e livehtml
 ```
 
+You can run a link checker on documentation.
+
+```shell
+tox -e linkcheck
+```
+
 The [`plone.api` documentation](https://6.docs.plone.org/plone.api) is automatically generated from the documentation source files when its submodule is updated in the [main Plone `documentation` repository](https://github.com/plone/documentation/).
 
 ## Add a function to an existing module

diff --git a/netlify.toml b/netlify.toml
diff --git a/news/546.documentation b/news/546.documentation
@@ -0,0 +1,6 @@
+Remove Netlify stuff, follow up to #545. @stevepiercy
+- Sort and remove duplicate entries in `pyproject.toml`
+- Remove unused docs requirements.
+- Fix comments and remove unnecessary steps from `tox.ini`.
+- Enable copy button for code blocks.
+- Add linkcheck to documentation of documentation.
diff --git a/pyproject.toml b/pyproject.toml
@@ -140,14 +140,14 @@ ignore = [
     "dependabot.yml",
     "mx.ini",
     "tox.ini",
-    ".editorconfig",
     "*.cfg",
+    ".editorconfig",
+    ".readthedocs.yaml",
     "constraints_plone52.txt",
     "constraints_plone60.txt",
     "constraints.txt",
     "fix-converted-myst.py",
     "Makefile",
-    "netlify.toml",
     "requirements-docs.txt",
     "requirements.txt",
 

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,12 +1,5 @@
-lesscpy
 linkify-it-py
 myst-parser
 plone-sphinx-theme
 sphinx-autobuild
 sphinx-copybutton
-sphinx-sitemap
-sphinx-togglebutton
-sphinxcontrib-spelling
-sphinxext-opengraph
-sphinxcontrib-video
-vale==2.30.0
diff --git a/tox.ini b/tox.ini
@@ -255,7 +255,7 @@ allowlist_externals =
     echo
 
 [testenv:plone6docs]
-# New docs with sphinx-book-theme
+# New docs with plone-sphinx-theme
 # See [testenv:docs] for classic documentation
 basepython = python3.11
 skip_install = False
@@ -272,13 +272,9 @@ commands =
     sphinx-build -b html -d _build/plone6docs/doctrees docs _build/plone6docs/html
 
 [testenv:rtd-preview]
-# New docs with sphinx-book-theme
-# See [testenv:docs] for classic documentation
+# Build docs on Read the Docs to preview pull requests using plone-sphinx-theme
 basepython = python3.11
 skip_install = False
-package = editable
-allowlist_externals =
-    mkdir
 extras =
     tests
 deps =