diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..f1c3ccc --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.8" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: requirements/docs.txt diff --git a/README.rst b/README.rst index 2194e1c..30910d1 100644 --- a/README.rst +++ b/README.rst @@ -5,11 +5,11 @@ :target: https://coveralls.io/r/ambitioninc/pagerduty-api .. image:: https://pypip.in/v/pagerduty-api/badge.png - :target: https://crate.io/packages/pagerduty-api/ + :target: https://pypi.python.org/pypi/pagerduty-api :alt: Latest PyPI version .. image:: https://pypip.in/d/pagerduty-api/badge.png - :target: https://crate.io/packages/pagerduty-api/ + :target: https://pypi.python.org/pypi/pagerduty-api :alt: Number of PyPI downloads diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 65711a1..e968e6b 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -1,6 +1,10 @@ Release Notes ============= +v0.5 +---- +* Read the docs config v2 + v0.3 ---- ``PAGERDUTY_API_KEY`` is no longer required for the ``Alert()`` object diff --git a/docs/usage.rst b/docs/usage.rst index d56ac03..7082be6 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,9 +1,6 @@ Usage ===== -Configuring Alerts ------------------- -Alerts has an environment variable will need to configure before using. Using Alerts ------------ @@ -19,7 +16,7 @@ unique ID generated in PagerDuty for a Generic API Service. Trigger Alert -~~~~~~~~~~~~~ +------------- To trigger an alert, use ``.trigger()`` on the interface. If you don't pass in an incident_key, one will be computed as the md5 hash of the description @@ -37,7 +34,7 @@ incident_key, one will be computed as the md5 hash of the description ) Acknowledge Alert -~~~~~~~~~~~~~~~~~ +----------------- To acknowledge an alert, use ``.acknowledge()`` on the interface. If you created this alert with ``.trigger()``, you won't need to provide an ``incident_key``. @@ -53,7 +50,7 @@ this alert with ``.trigger()``, you won't need to provide an ``incident_key``. ) Resolve Alert -~~~~~~~~~~~~~ +------------- To resolve an alert, use ``.resolve()`` on the interface. If you created this alert with ``.trigger()``, you won't need to provide an ``incident_key``. diff --git a/pagerduty_api/version.py b/pagerduty_api/version.py index cce384d..5a6f84c 100644 --- a/pagerduty_api/version.py +++ b/pagerduty_api/version.py @@ -1 +1 @@ -__version__ = '0.3' +__version__ = '0.5' diff --git a/setup.py b/setup.py index 7494a3d..6be4bf8 100644 --- a/setup.py +++ b/setup.py @@ -5,6 +5,12 @@ from setuptools import setup, find_packages +import sys +if 'sdist' in sys.argv and sys.version_info < (2, 7, 9, 'final', 0): + import os + del os.link + + def get_version(): """ Extracts the version number from the version.py file.