diff --git a/bob/devtools/scripts/ci.py b/bob/devtools/scripts/ci.py index 43a2fbc73d94d342f0b7de80a328717614e8c040..e71f7032c22d45e34a4422b2f4cafd6ae2956289 100644 --- a/bob/devtools/scripts/ci.py +++ b/bob/devtools/scripts/ci.py @@ -651,9 +651,14 @@ def docs(ctx, requirement, dry_run): """Prepares documentation build This command: + \b + 1. Clones all the necessary packages necessary to build the bob/beat documentation + \b + 2. Generates the `extra-intersphinx.txt` and `nitpick-exceptions.txt` file + \b This command is supposed to be run **instead** of `bdt ci build...` diff --git a/bob/devtools/scripts/local.py b/bob/devtools/scripts/local.py index e5b892777a1c9928857c12a338ce6de0a89cc622..2eca76070ddb62b531042cde12d5b85bb1b8598a 100644 --- a/bob/devtools/scripts/local.py +++ b/bob/devtools/scripts/local.py @@ -73,11 +73,18 @@ def docs(ctx, requirement, dry_run, python, group): """Prepares documentation build This command: + \b + 1. Clones all the necessary packages necessary to build the bob/beat documentation + + \b + 2. Generates the `extra-intersphinx.txt` and `nitpick-exceptions.txt` file + + \b """ set_up_environment_variables(python=python, name_space=group) - ctx.invoke(ci.docs, requirement=requirement, dry_run=dry_run) \ No newline at end of file + ctx.invoke(ci.docs, requirement=requirement, dry_run=dry_run)