Skip to content

Commit 4e81ef4

Browse files
committed
Updated documentation build and dependencies
1 parent 6afd9d6 commit 4e81ef4

8 files changed

Lines changed: 32 additions & 31 deletions

File tree

docs/api.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
API reference
2+
=============
3+
4+
Component
5+
---------
6+
7+
.. autoclass:: asphalt.exceptions.component.ExceptionReporterComponent
8+
:members:
9+
10+
Functions
11+
---------
12+
13+
.. autofunction:: asphalt.exceptions.report_exception
14+
15+
Abstract classes
16+
----------------
17+
18+
.. automodule:: asphalt.exceptions.api
19+
:members:
20+
21+
Exception reporters
22+
-------------------
23+
24+
.. autoclass:: asphalt.exceptions.reporters.sentry.SentryExceptionReporter
25+
:members:
26+
27+
.. autoclass:: asphalt.exceptions.reporters.raygun.RaygunExceptionReporter
28+
:members:

docs/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
.. include:: ../README.rst
2-
:start-line: 7
2+
:start-line: 10
33
:end-before: Project links
44

55
Table of contents
@@ -11,6 +11,5 @@ Table of contents
1111
configuration
1212
usage
1313
extending
14+
api
1415
versionhistory
15-
16-
* :ref:`API reference <modindex>`

docs/modules/api.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/modules/component.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/modules/index.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/modules/reporters/raygun.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/modules/reporters/sentry.rst

Lines changed: 0 additions & 5 deletions
This file was deleted.

pyproject.toml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,9 @@ test = [
4545
]
4646
doc = [
4747
"asphalt-exceptions[sentry,raygun]",
48-
"Sphinx >= 1.5",
49-
"sphinx_rtd_theme",
48+
"Sphinx >= 7",
49+
"sphinx_rtd_theme >= 1.3.0",
5050
"sphinx-autodoc-typehints >= 1.2.0",
51-
"sphinxcontrib-asyncio >= 0.2.0",
5251
]
5352
sentry = ["sentry-sdk >= 1.5"]
5453
raygun = ["raygun4py >= 4.3"]

0 commit comments

Comments
 (0)