Skip to content

Testing docs and doc tests #432

Description

@pytestbot

Originally reported by: Piotr Banaszkiewicz (BitBucket: pbanaszkiewicz, GitHub: pbanaszkiewicz)


Testing docs with tox right now requires make. Not everyone has it installed.
(And regen target for tox doesn't work, too)

I propose to expand testing docs and doctests so that:

  1. rst syntax in docstrings is checked
  2. make is no longed needed
  3. doc trees are shared per tox env. run
  4. rm -rf is not needed (lets not repeat other projects' mistakes)
  5. Sphinx is more strict about warnings (-W)

I'm ready to submit a pull request if you agree.

I would also like to somehow force developers to write docs about implemented new features or changed pytest behavior.


Activity

  1. added
    type: proposalproposal for a new feature, often to gather opinions or design the API around the new feature
    on Jun 15, 2015
  2. added
    type: docsdocumentation improvement, missing or needing clarification
    on Jul 25, 2015
  3. nicoddemus commented on Jul 13, 2016

    @nicoddemus
    Member

    Bump this... had this in the back of my mind for a while now, specially changing sphinx warnings to errors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    type: docsdocumentation improvement, missing or needing clarificationtype: proposalproposal for a new feature, often to gather opinions or design the API around the new feature

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions