Skip to content

Add doc tests (pytest-markdown-docs) to template #88

@JnyJny

Description

@JnyJny

Port the doc testing setup from busylight-core to the cookiecutter template so all new projects get it out of the box.

What to add:

  • pytest-markdown-docs in dev dependencies
  • docs/conftest.py scaffold with pytest_markdown_docs_globals() hook
  • poe doc-test task: pytest --markdown-docs docs/ --ignore=docs/gen_ref_pages.py
  • Include doc-test in poe qc sequence
  • CI workflow: add poe doc-test step alongside unit tests (both ci.yml and release.yaml)
  • CONTRIBUTING.md and CLAUDE.md sections explaining doc tests, continuation/notest markers
  • Auto-merge on LGTM workflow (auto-merge.yml)
  • Branch protection setup notes in README or CONTRIBUTING

Reference implementation: JnyJny/busylight-core PR #47 and #48.


Authored by Jny

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions