search

plone / plone.api

The Plone API
https://6.docs.plone.org/plone.api
Other
88 stars 53 forks source link

Re-add testing of code blocks in documentation with sybil #477

Closed ksuess closed 2 years ago

ksuess commented 2 years ago

Testing of code blocks in documentation with sybil: https://github.com/simplistix/sybil

See how to run tests locally in development guide: https://github.com/plone/plone.api/blob/re-add-doctests-sybil/docs/contribute/develop.md#creating-and-using-the-development-environment

Run all tests and checks: tox

List all tests and checks run by tox: tox -l

More helpers can be found in tox.ini

mister-roboto commented 2 years ago

@ksuess thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

ksuess commented 2 years ago

@jenkins-plone-org please run jobs

ksuess commented 2 years ago

Closed in favor of #478