diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml index 2b88174..efe6ef4 100644 --- a/.github/workflows/run-tests.yml +++ b/.github/workflows/run-tests.yml @@ -34,14 +34,11 @@ jobs: coverage run -m unittest coverage report coverage xml -o ./coverage.xml - - name: Generate documentation - run: | - sphinx-build -b html -W --no-color docs build/sphinx/html - name: Upload coverage - uses: codecov/codecov-action@v1.0.2 + uses: codecov/codecov-action@v1.3.2 with: - token: ${{ secrets.CODECOV_TOKEN }} + token: ${{secrets.CODECOV_TOKEN}} file: ./coverage.xml flags: unittests - env_vars: OS,PYTHON fail_ci_if_error: true + verbose: true diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6f83b67 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +version: 2 + +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: true + +python: + version: 3.7 + install: + - method: pip + path: . + extra_requirements: + - readthedocs + system_packages: true diff --git a/MANIFEST.in b/MANIFEST.in index d2b04be..b0c6f95 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -5,3 +5,5 @@ include CHANGELOG.rst include example.py include LICENSE include tox.ini + +global-exclude *.pyc diff --git a/README.rst b/README.rst index aec5e05..d949f58 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,10 @@ Asynchronously send metrics to a statsd_ instance. +|build| |coverage| |source| + +.. COMMENTED OUT FOR THE TIME BEING + |docs| |download| |license| + This library provides connectors to send metrics to a statsd_ instance using either TCP or UDP. .. code-block:: python @@ -115,3 +120,16 @@ not connected to the server and will be sent in the order received when the task .. _statsd: https://github.com/statsd/statsd/ .. _tornado: https://tornadoweb.org/ + +.. |build| image:: https://img.shields.io/github/workflow/status/sprockets/sprockets-statsd/Testing/main?style=social + :target: https://github.com/sprockets/sprockets-statsd/actions/workflows/run-tests.yml +.. |coverage| image:: https://img.shields.io/codecov/c/github/sprockets/sprockets-statsd?style=social + :target: https://app.codecov.io/gh/sprockets/sprockets-statsd +.. |docs| image:: https://img.shields.io/readthedocs/sprockets-statsd.svg?style=social + :target: https://sprockets-statsd.readthedocs.io/en/latest/?badge=latest +.. |download| image:: https://img.shields.io/pypi/pyversions/sprockets-statsd.svg?style=social + :target: https://pypi.org/project/sprockets-statsd/ +.. |license| image:: https://img.shields.io/pypi/l/sprockets-statsd.svg?style=social + :target: https://github.com/sprockets/sprockets-statsd/blob/master/LICENSE.txt +.. |source| image:: https://img.shields.io/badge/source-github.com-green.svg?style=social + :target: https://github.com/sprockets/sprockets-statsd diff --git a/setup.cfg b/setup.cfg index ded2401..b90bd16 100644 --- a/setup.cfg +++ b/setup.cfg @@ -42,6 +42,10 @@ dev = sphinx-autodoc-typehints==1.11.1 tornado>=5 yapf==0.30.0 +readthedocs = + sphinx==3.5.2 + sphinx-autodoc-typehints==1.11.1 + tornado>=5 [options.packages.find] exclude =