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

Testing docs and doc tests #432

Closed
pytestbot opened this issue Jan 24, 2014 · 1 comment
Closed

Testing docs and doc tests #432

pytestbot opened this issue Jan 24, 2014 · 1 comment
Labels
type: docs documentation improvement, missing or needing clarification type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature

Comments

@pytestbot
Copy link
Contributor

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.


@pytestbot pytestbot added the type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature label Jun 15, 2015
@pfctdayelise pfctdayelise added the type: docs documentation improvement, missing or needing clarification label Jul 25, 2015
@nicoddemus
Copy link
Member

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

nicoddemus added a commit that referenced this issue Aug 23, 2016
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829
nicoddemus added a commit that referenced this issue Aug 23, 2016
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Aug 23, 2016
* Changed "index" to be more similar to the README (pytest-dev#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (pytest-dev#1829, pytest-dev#432).
* Mention all docs in "contents.rst" so it's easier for users to locate (pytest-dev#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes pytest-dev#432, Fixes pytest-dev#1112, Fixes pytest-dev#1708, Fixes pytest-dev#1829
nicoddemus added a commit that referenced this issue Aug 23, 2016
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829
nicoddemus added a commit that referenced this issue Aug 26, 2016
* Changed "index" to be more similar to the README (#1708).
* Fixes numerous issues like missing documents, syntax errors, etc (#1829, #432).
* Mention all docs in "contents.rst" so it's easier for users to locate (#1112).
* Add doc generation and checking to Travis and AppVeyor, to avoid re-introducing errors.

Fixes #432, Fixes #1112, Fixes #1708, Fixes #1829
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification type: proposal proposal for a new feature, often to gather opinions or design the API around the new feature
Projects
None yet
Development

No branches or pull requests

3 participants