Skip to content

Commit 4460637

Browse files
committed
Convert enum value comments from doxygen syntax to sphinx syntax
1 parent d21b55e commit 4460637

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

docs/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
autoapi_member_order = 'alphabetical'
4747
autoapi_own_page_level = 'class'
4848
autoapi_python_class_content = 'both'
49+
autoapi_options = [ 'members', 'undoc-members', 'private-members', 'show-inheritance', 'show-module-summary' ]
4950

5051
# -- Options for HTML output -------------------------------------------------
5152
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

generated/3.0/vlc.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@
5252

5353
logger = logging.getLogger(__name__)
5454

55-
__version__ = "3.0.21202"
55+
__version__ = "3.0.21203"
5656
__libvlc_version__ = "3.0.21"
57-
__generator_version__ = "2.2"
58-
build_date = "Mon Oct 7 14:14:00 2024 3.0.21"
57+
__generator_version__ = "2.3"
58+
build_date = "Mon Oct 7 16:36:40 2024 3.0.21"
5959

6060
# The libvlc doc states that filenames are expected to be in UTF8, do
6161
# not rely on sys.getfilesystemencoding() which will be confused,
@@ -3950,9 +3950,11 @@ class EventType(_Enum):
39503950
* ``vlc.EventType.MediaListPlayerPlayed``
39513951
* ``vlc.EventType.MediaListPlayerNextItemSet``
39523952
* ``vlc.EventType.MediaListPlayerStopped``
3953-
* ``vlc.EventType.MediaDiscovererStarted`` \deprecated Useless event, it will be triggered only when calling
3953+
* ``vlc.EventType.MediaDiscovererStarted``
3954+
.. warning:: **Deprecated!** Useless event, it will be triggered only when calling
39543955
libvlc_media_discoverer_start()
3955-
* ``vlc.EventType.MediaDiscovererEnded`` \deprecated Useless event, it will be triggered only when calling
3956+
* ``vlc.EventType.MediaDiscovererEnded``
3957+
.. warning:: **Deprecated!** Useless event, it will be triggered only when calling
39563958
libvlc_media_discoverer_stop()
39573959
* ``vlc.EventType.RendererDiscovererItemAdded``
39583960
* ``vlc.EventType.RendererDiscovererItemDeleted``

generator/generate.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151

5252
# Version number MUST have a major < 10 and a minor < 99 so that the
5353
# generated dist version can be correctly generated (major * 100 + minor).
54-
__version__ = "2.2"
54+
__version__ = "2.3"
5555

5656
_debug = False
5757

@@ -2283,7 +2283,10 @@ def generate_enums(self):
22832283
# Add names in generated docstring
22842284
# so that they are available in Sphinx-generated doc
22852285
symbols = _NL_.join(
2286-
[f" * ``vlc.{cls}.{v.name}`` { v.docs }" for v in e.vals]
2286+
[
2287+
f" * ``vlc.{cls}.{v.name}`` { "\n".join(e.base_sphinx_format(v.docs)) }"
2288+
for v in e.vals
2289+
]
22872290
)
22882291
docs = f"""{docs}
22892292

0 commit comments

Comments
 (0)