diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-01 21:07:21 +0200 |
|---|---|---|
| committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-01 21:07:21 +0200 |
| commit | cbd4d52b11150594ec29b1ce52348c1086a778c8 (patch) | |
| tree | c2948f41c01a5f48101678edde058900bb8267c7 /docs | |
| parent | 5061972f7852002927805d82f133239d48141eb9 (diff) | |
| download | gitlab-cbd4d52b11150594ec29b1ce52348c1086a778c8.tar.gz | |
docs: fail on warnings during sphinx build
This is useful when docs aren't included in the toctree and don't show up on RTD.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-objects.rst | 3 | ||||
| -rw-r--r-- | docs/cli-usage.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/deploy_tokens.rst | 4 | ||||
| -rw-r--r-- | docs/gl_objects/milestones.rst | 2 | ||||
| -rw-r--r-- | docs/gl_objects/mr_approvals.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/packages.rst | 4 | ||||
| -rw-r--r-- | docs/gl_objects/remote_mirrors.rst | 4 | ||||
| -rw-r--r-- | docs/gl_objects/runners.rst | 2 |
8 files changed, 13 insertions, 9 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 5bcbe24..2f1be1a 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -15,6 +15,7 @@ API examples gl_objects/messages gl_objects/commits gl_objects/deploy_keys + gl_objects/deploy_tokens gl_objects/deployments gl_objects/discussions gl_objects/environments @@ -34,8 +35,10 @@ API examples gl_objects/notes gl_objects/packages gl_objects/pagesdomains + gl_objects/personal_access_tokens gl_objects/pipelines_and_jobs gl_objects/projects + gl_objects/project_access_tokens gl_objects/protected_branches gl_objects/releases gl_objects/runners diff --git a/docs/cli-usage.rst b/docs/cli-usage.rst index c1b59bf..983b3e7 100644 --- a/docs/cli-usage.rst +++ b/docs/cli-usage.rst @@ -403,7 +403,7 @@ command line. This is handy for values containing new lines for instance: $ gitlab project create --name SuperProject --description @/tmp/description Enabling shell autocompletion -============================ +============================= To get autocompletion, you'll need to install the package with the extra "autocompletion": diff --git a/docs/gl_objects/deploy_tokens.rst b/docs/gl_objects/deploy_tokens.rst index 404bf09..27f2a23 100644 --- a/docs/gl_objects/deploy_tokens.rst +++ b/docs/gl_objects/deploy_tokens.rst @@ -1,6 +1,6 @@ -####### +############# Deploy tokens -####### +############# Deploy tokens allow read-only access to your repository and registry images without having a user and a password. diff --git a/docs/gl_objects/milestones.rst b/docs/gl_objects/milestones.rst index 40f9ba6..3830f81 100644 --- a/docs/gl_objects/milestones.rst +++ b/docs/gl_objects/milestones.rst @@ -75,7 +75,7 @@ List the merge requests related to a milestone:: merge_requests = milestone.merge_requests() Milestone events -============ +================ Resource milestone events keep track of what happens to GitLab issues and merge requests. diff --git a/docs/gl_objects/mr_approvals.rst b/docs/gl_objects/mr_approvals.rst index ee0377d..9e47535 100644 --- a/docs/gl_objects/mr_approvals.rst +++ b/docs/gl_objects/mr_approvals.rst @@ -76,6 +76,7 @@ Change MR-level MR approval rule:: mr_approvalrule.save() Create a MR-level MR approval rule:: + mr.approval_rules.create({ "name": "my MR custom approval rule", "approvals_required": 2, diff --git a/docs/gl_objects/packages.rst b/docs/gl_objects/packages.rst index 47b5fe6..60c4436 100644 --- a/docs/gl_objects/packages.rst +++ b/docs/gl_objects/packages.rst @@ -1,6 +1,6 @@ -####### +######## Packages -####### +######## Packages allow you to utilize GitLab as a private repository for a variety of common package managers. diff --git a/docs/gl_objects/remote_mirrors.rst b/docs/gl_objects/remote_mirrors.rst index 72a39e0..9024228 100644 --- a/docs/gl_objects/remote_mirrors.rst +++ b/docs/gl_objects/remote_mirrors.rst @@ -1,6 +1,6 @@ -########## +###################### Project Remote Mirrors -########## +###################### Remote Mirrors allow you to set up push mirroring for a project. diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index b369bed..1919975 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -79,7 +79,7 @@ Verify a registered runner token:: print("Invalid token") Project/Group runners -=============== +===================== Reference --------- |