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

Travis chores for new release #29

Closed
wants to merge 1 commit into from
Closed
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
8 changes: 8 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,11 @@ repos:
rev: 3.7.8
hooks:
- id: flake8
- repo: local
hooks:
- id: travis-lint
name: Travis YAML linter
description: This hook lints .travis.yml files.
entry: travis lint --skip-completion-check --skip-version-check --exit-code --
language: ruby
files: \.travis\.yml$
7 changes: 4 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ os:
# tox 3.8.0 is the first version that can boostrap itself
before_script:
- pip install tox>=3.8.0
# needed by pre-commit:
- gem install travis --no-rdoc --no-ri

# test script
script: tox
Expand All @@ -19,6 +21,8 @@ notifications:

jobs:
fast_finish: true
exclude:
if: tag IS present
include:
- name: lint,docs,py37
env: TOXENV=lint,docs
Expand All @@ -38,9 +42,6 @@ jobs:

deploy:
provider: pypi
username: __token__
password:
secure: "fSEPPa9lkEiqNZKMs0qCdI3gSWYSoqjj+gk33bvZXpWvIYkrRGNYt77be6lAdNX4SBW2LaaHmAd8WZ9YuaYTfTfNksn25mSjOKw3yEhmus9V7r5VmLyODIlhuDmn+RGenzf1wKEXKdBJQ8qXjzH1R2MbagIEjApyTWTYX4tfjoMR5v41g+wP4VC9wwjQx6q7oZhwQWj/9nSw8Ww45By1ozH2E4oT5bGSS/guXxuLsQ+oUfQfe+9Ht8kiT4n7RbfHyYQTe3VjV1IZ0hhiiA/SxF0UwsPt4Lr242W59TkaGayWjbSNCv7REQQXyHGKLcns5C50eD3Up6ZDmehOpiGf8TUCwb7FuAi71lD+Rr6Uu7IY44nUlsCDeQ9/sqKGWLsJSZgf4mBYJBqSx9GD+1eqmBPx/AONbVTUdhWh2Ve+JfXztfBeJpdKmmUsRC3CjqbIf8UKNDz5zcuUJ7yv4o0V+SunUDSdMOxkYaW9tP4YwJQqwCpNOi5R80JjhJq4bwvjdhGatC7oLDuoZ17R7b9OrBT8TpaXr/R+rgC66AHxmC/qgxZf4z7he+6vtmJPnVNUDzKj24t0wPVHprZkCSkLPf00gFU4UvG+J2OTCaHEImHtL5dp2wv+NgQbnm5d6xCUb80LW38AGx6E46potk+mnkMM1P4+W1tmtoYkDX6eIB0="
edge: true # opt in to dpl v2
distributions: "sdist bdist_wheel"
skip_existing: true
Expand Down
29 changes: 17 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
.. image:: https://travis-ci.com/PyCQA/doc8.svg?branch=master
:target: https://travis-ci.com/PyCQA/doc8
.. image:: https://img.shields.io/pypi/v/doc8
:alt: PyPI
:target: https://pypi.org/project/doc8/
:alt: PyPI
:target: https://pypi.org/project/doc8/

.. image:: https://travis-ci.com/PyCQA/doc8.svg?branch=master
:target: https://travis-ci.com/PyCQA/doc8
:alt: CI

.. image:: https://img.shields.io/pypi/l/doc8
:alt: PyPI - License
:alt: PyPI - License

.. image:: https://img.shields.io/github/last-commit/pycqa/doc8
:alt: GitHub last commit
:alt: GitHub last commit


====
Doc8
Expand All @@ -24,7 +29,7 @@ QuickStart

To run doc8 just invoke it against any doc directory::

$ doc8 coolproject/docs
$ doc8 cool-project/docs

Usage
=====
Expand All @@ -45,7 +50,7 @@ Command line usage
Check documentation for simple style requirements.

What is checked:
- invalid rst format - D000
- invalid RST format - D000
- lines should not be longer than 79 characters - D001
- RST exception: line with no whitespace except in the beginning
- RST exception: lines with http or https urls
Expand Down Expand Up @@ -91,8 +96,8 @@ Ini file usage
**************

Instead of using the CLI for options the following files will also be examined
for ``[doc8]`` sections that can also provided the same set of options. If
the ``--config path`` option is used these files will **not** be scanned for
for ``[doc8]`` sections that can also provide the same set of options. If
the ``--config path`` option is used, these files will **not** be scanned for
the current working directory and that configuration path will be used
instead.

Expand All @@ -111,13 +116,13 @@ An example section that can be placed into one of these files::
ignore-path-errors=/tmp/other_thing.rst;D001;D002

**Note:** The option names are the same as the command line ones (with the
only variation of this being the ``no-sphinx`` option which from
only variation of this being the ``no-sphinx`` option which from the
configuration file will be ``sphinx`` instead).

Python Usage
************

To call doc8 from a Python project::
To call doc8 from a Python project do::

from doc8 import doc8

Expand Down