Skip to content

Commit

Permalink
Merge pull request #732 from NatLibFi/completion-command-to-rtd
Browse files Browse the repository at this point in the history
Add completion command to commands list in RTD
  • Loading branch information
juhoinkinen authored Aug 22, 2023
2 parents fd8561d + 4bcbf28 commit a231fb3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion annif/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
11 changes: 11 additions & 0 deletions docs/source/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,14 @@ Subject index administration
**REST equivalent**

N/A

*****
Other
*****

.. click:: annif.cli:run_completion
:prog: annif completion

**REST equivalent**

N/A

0 comments on commit a231fb3

Please sign in to comment.