Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Netlify stuff, follow up to #545 #546

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .meta.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ check_manifest_ignores = """
"constraints.txt",
"fix-converted-myst.py",
"Makefile",
"netlify.toml",
"requirements-docs.txt",
"requirements.txt",
"""
Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]
master_doc = "index"

Expand Down Expand Up @@ -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 ----------------------------------
Expand Down
6 changes: 6 additions & 0 deletions docs/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 0 additions & 5 deletions netlify.toml

This file was deleted.

6 changes: 6 additions & 0 deletions news/546.documentation
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 7 additions & 9 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -133,24 +133,22 @@ ignore-packages = ['Products.PrintingMailHost', 'plone.app.iterate',]

[tool.check-manifest]
ignore = [
"*.cfg",
".editorconfig",
".flake8",
".meta.toml",
".pre-commit-config.yaml",
"dependabot.yml",
"mx.ini",
"tox.ini",
".editorconfig",
"*.cfg",
".readthedocs.yaml",
"Makefile",
"constraints.txt",
"constraints_plone52.txt",
"constraints_plone60.txt",
"constraints.txt",
"dependabot.yml",
"fix-converted-myst.py",
"Makefile",
"netlify.toml",
"mx.ini",
"requirements-docs.txt",
"requirements.txt",

"tox.ini",
]

##
Expand Down
7 changes: 0 additions & 7 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -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
8 changes: 2 additions & 6 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 =
Expand Down
Loading