Skip to content

Commit 9b4ad96

Browse files
committed
Fix sphinx errors and warnings
1 parent 2986272 commit 9b4ad96

File tree

3 files changed

+9
-14
lines changed

3 files changed

+9
-14
lines changed

docs/API.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,6 @@ The base meta class is a PluginMount:
4343
.. autoclass:: pydifact.api.PluginMount
4444

4545

46-
Available entry points for plugins are:
47-
48-
.. autoclass:: pydifact.segments.SegmentProvider
49-
:members:
50-
51-
.. automethod:: SegmentProvider.__str__
52-
46+
:class:`~pydifact.segments.SegmentProvider` uses
47+
:class:`~pydifact.api.PluginMount` and can thus be
48+
extended with plugins.

docs/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@
4747
html_theme = "sphinx_rtd_theme"
4848

4949
html_theme_options = {
50-
"canonical_url": "https://pydifact.readthedocs.io/",
5150
# "logo_only": False,
5251
"display_version": True,
5352
"prev_next_buttons_location": "both",

pydifact/segmentcollection.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -352,12 +352,12 @@ def validate(self):
352352

353353
class Message(AbstractSegmentsContainer):
354354
"""
355-
A message (started by UNH segment, ended by UNT segment)
355+
A message (started by UNH_ segment, ended by UNT_ segment)
356356
357357
Optional features of UNH are not yet supported.
358358
359-
https://www.stylusstudio.com/edifact/40100/UNH_.htm
360-
https://www.stylusstudio.com/edifact/40100/UNT_.htm
359+
.. _UNH: https://www.stylusstudio.com/edifact/40100/UNH_.htm
360+
.. _UNT: https://www.stylusstudio.com/edifact/40100/UNT_.htm
361361
"""
362362

363363
HEADER_TAG = "UNH"
@@ -407,7 +407,7 @@ def validate(self):
407407

408408
class Interchange(FileSourcableMixin, UNAHandlingMixin, AbstractSegmentsContainer):
409409
"""
410-
An interchange (started by UNB segment, ended by UNZ segment)
410+
An interchange (started by UNB_ segment, ended by UNZ_ segment)
411411
412412
Optional features of UNB are not yet supported.
413413
@@ -417,8 +417,8 @@ class Interchange(FileSourcableMixin, UNAHandlingMixin, AbstractSegmentsContaine
417417
optional: interchange segments can be accessed without going through
418418
messages.
419419
420-
https://www.stylusstudio.com/edifact/40100/UNB_.htm
421-
https://www.stylusstudio.com/edifact/40100/UNZ_.htm
420+
.. _UNB: https://www.stylusstudio.com/edifact/40100/UNB_.htm
421+
.. _UNZ: https://www.stylusstudio.com/edifact/40100/UNZ_.htm
422422
"""
423423

424424
HEADER_TAG = "UNB"

0 commit comments

Comments
 (0)