Merge pull request #732 from NatLibFi/completion-command-to-rtd

Add completion command to commands list in RTD
NatLibFi · Aug 22, 2023 · a231fb3 · a231fb3
2 parents fd8561d + 4bcbf28
commit a231fb3
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/annif/cli.py b/annif/cli.py
@@ -587,7 +587,7 @@ def run_hyperopt(project_id, paths, docs_limit, trials, jobs, metric, results_fi
 @click.option("--bash", "shell", flag_value="bash")
 @click.option("--zsh", "shell", flag_value="zsh")
 @click.option("--fish", "shell", flag_value="fish")
-def completion(shell):
+def run_completion(shell):
     """Generate the script for tab-key autocompletion for the given shell. To enable the
     completion support in your current bash terminal session run\n
         source <(annif completion --bash)

diff --git a/docs/source/commands.rst b/docs/source/commands.rst
@@ -127,3 +127,14 @@ Subject index administration
 **REST equivalent**
 
    N/A
+
+*****
+Other
+*****
+
+.. click:: annif.cli:run_completion
+   :prog: annif completion
+
+**REST equivalent**
+
+   N/A