fix doctest errors

README.rst

@@ -6,16 +6,12 @@ Subtitles, faster than your thoughts.
     :target: https://pypi.python.org/pypi/subliminal
     :alt: Latest Version
 
-.. image:: https://travis-ci.org/Diaoul/subliminal.svg?branch=develop
-    :target: https://travis-ci.org/Diaoul/subliminal
-    :alt: Travis CI build status
-
 .. image:: https://readthedocs.org/projects/subliminal/badge/?version=latest
     :target: https://subliminal.readthedocs.org/
     :alt: Documentation Status
 
-.. image:: https://coveralls.io/repos/Diaoul/subliminal/badge.svg?branch=develop&service=github
-    :target: https://coveralls.io/github/Diaoul/subliminal?branch=develop
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Diaoul/subliminal/python-coverage-comment-action-data/endpoint.json
+    :target: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Diaoul/subliminal/python-coverage-comment-action-data/endpoint.json
     :alt: Code coverage
 
 .. image:: https://img.shields.io/github/license/Diaoul/subliminal.svg
@@ -77,13 +73,27 @@ Run subliminal in a docker container::
 
 Installation
 ------------
-Subliminal can be installed as a regular python module by running::
+For a better isolation with your system you should use a dedicated virtualenv.
+The preferred installation method is to use `pipx <https://github.com/pypa/pipx>`_ that does that for you::
+
+    $ pipx install subliminal
+
+Subliminal can be also be installed as a regular python module by running::
 
-    $ [sudo] pip install subliminal
+    $ pip install --user subliminal
+
+If you want to modify the code, `fork <https://github.com/Diaoul/subliminal/fork>`_ this repo,
+clone your fork locally and install a development version::
+
+    $ git clone https://github.com/<my-username>/subliminal
+    $ cd subliminal
+    $ pip install --user -e '.[dev,test,docs]'
 
-For a better isolation with your system you should use a dedicated virtualenv or install for your user only using
-the ``--user`` flag.
 
 Nautilus/Nemo integration
 -------------------------
 See the dedicated `project page <https://github.com/Diaoul/nautilus-subliminal>`_ for more information.
+
+Dolphin integration
+-------------------
+See this `Gist <https://gist.github.com/maurocolella/03a9f02c56b1a90c64f05683e2840d57>`_.

changelog.d/1143.doc.rst

@@ -0,0 +1 @@
+fix doctest errors

docs/_static/.gitignore

@@ -0,0 +1 @@
+!.gitignore

docs/conf.py

@@ -35,6 +35,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
     'sphinxcontrib.programoutput',

docs/index.rst

@@ -25,6 +25,7 @@ API Documentation
 If you are looking for information on a specific function, class or method, this part of the documentation is for you.
 
 .. toctree::
+    :caption: API
     :maxdepth: 1
 
     api/core

docs/user/usage.rst

@@ -160,5 +160,5 @@ We got ourselves a nice subtitle, now we can save it on the file system using :f
 
     >>> save_subtitles(video, [best_subtitle])
     [<PodnapisiSubtitle 'ZtAW' [hu]>]
-    >>> os.listdir()
-    ['The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.hu.srt']
+    >>> 'The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.hu.srt' in os.listdir()
+    True

subliminal/cli.py

@@ -78,7 +78,7 @@ class LanguageParamType(click.ParamType):
     name = 'language'
 
     def convert(self, value: str, param: click.Parameter | None, ctx: click.Context | None) -> Language:
-        """Convert ietf language to :class:`~babelfish.Language`."""
+        """Convert ietf language to :class:`~babelfish.language.Language`."""
         try:
             return Language.fromietf(value)
         except BabelfishError: