Skip to content

Commit

Permalink
- Move tox.ini for documentation configuration into .meta.toml.
Browse files Browse the repository at this point in the history
- Revert sort of `.gitignore` and add `.readthedocs.yaml` to the correct stanza in `.meta.toml`.
  • Loading branch information
stevepiercy committed Jan 6, 2025
1 parent 4905017 commit db089b9
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 8 deletions.
33 changes: 31 additions & 2 deletions .meta.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ 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",
Expand Down Expand Up @@ -76,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
Expand All @@ -92,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
Expand Down Expand Up @@ -126,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]
Expand Down
14 changes: 8 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -133,22 +133,24 @@ 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",
"*.cfg",
".editorconfig",
".readthedocs.yaml",
"Makefile",
"constraints.txt",
"constraints_plone52.txt",
"constraints_plone60.txt",
"dependabot.yml",
"constraints.txt",
"fix-converted-myst.py",
"mx.ini",
"Makefile",
"requirements-docs.txt",
"requirements.txt",
"tox.ini",

]

##
Expand Down

0 comments on commit db089b9

Please sign in to comment.