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

Replaced pep257 with pydocstyle. #100

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ env:
- TOXENV=project-tox-flake8
- TOXENV=project-tox-isort
- TOXENV=project-tox-manifest
- TOXENV=project-tox-pep257
- TOXENV=project-tox-pydocstyle
- TOXENV=project-tox-py27
- TOXENV=project-tox-py35
- TOXENV=py27-project-develop
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Lint Tools
* `doc8 <https://github.com/openstack/doc8>`_
* `flake8 <https://gitlab.com/pycqa/flake8>`_
* `isort <https://github.com/timothycrosley/isort>`_
* `pep257 <https://github.com/GreenSteam/pep257>`_
* `pydocstyle <https://github.com/PyCQA/pydocstyle>`_

Testing
-------
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = py27,py34,py35,pypy,docs,flake8,isort,project-tox-{docs,flake8,isort,manifest,pep257,py27,py35},{py27,py34,py35}-project-develop
envlist = py27,py34,py35,pypy,docs,flake8,isort,project-tox-{docs,flake8,isort,manifest,pydocstyle,py27,py35},{py27,py34,py35}-project-develop
minversion = 2.1.0
skipsdist = True

Expand All @@ -13,7 +13,7 @@ commands =
project-tox-flake8: tox -c my-project/tox.ini -e flake8
project-tox-isort: tox -c my-project/tox.ini -e isort
project-tox-manifest: {toxinidir}/test_manifest.sh
project-tox-pep257: tox -c my-project/tox.ini -e pep257
project-tox-pydocstyle: tox -c my-project/tox.ini -e pydocstyle
project-tox-py27: tox -c my-project/tox.ini -e py27
project-tox-py35: tox -c my-project/tox.ini -e py35
deps =
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.repo_name }}/MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include tox.ini
exclude .bumpversion.cfg
exclude .editorconfig
exclude .pre-commit-config.yaml
exclude pep257.sh
exclude pydocstyle.sh

recursive-include docs *.rst .gitkeep conf.py Makefile make.bat
recursive-include requirements *.pip
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env bash
#
# Find all Python files and check their docstrings with pep257.
# Find all Python files and check their docstrings with pydocstyle.

set -o errexit
set -o nounset
set -o pipefail

find . -name '*.py' -not -path './.*/*' -not -path '*/migrations/*' -not -path './node_modules/*' -exec pep257 -s {} +
find . -name '*.py' -not -path './.*/*' -not -path '*/migrations/*' -not -path './node_modules/*' -exec pydocstyle -s {} +
2 changes: 1 addition & 1 deletion {{ cookiecutter.repo_name }}/setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ known_first_party = {{ cookiecutter.pkg_name }},tests
known_third_party = braces,configurations,coverage,crispy_forms,dj_database_url,django,envdir,factory,factory_boy,faker,fauxfactory,freezegun,grappelli,psycopg2,pytest,pytest_factoryboy,six
skip = manage.py,migrations,wsgi.py

[pep257]
[pydocstyle]
add-ignore = D100,D104

[pytest]
Expand Down
8 changes: 4 additions & 4 deletions {{ cookiecutter.repo_name }}/tox.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = py27,py35,flake8,isort,manifest,docs,pep257
envlist = py27,py35,flake8,isort,manifest,docs,pydocstyle
minversion = 2.1.0

[testenv]
Expand Down Expand Up @@ -40,12 +40,12 @@ deps =
check-manifest==0.29
skip_install = True

[testenv:pep257]
[testenv:pydocstyle]
basepython = python3.5
commands =
{toxinidir}/pep257.sh
{toxinidir}/pydocstyle.sh
deps =
pep257==0.7.0
pydocstyle==1.0.0
skip_install = True

[testenv:docs]
Expand Down