FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: fail on warnings during sphinx build · python-gitlab/python-gitlab@cbd4d52 · GitHub

  1. python-gitlab
  2. python-gitlab

Repository navigation

Commit cbd4d52

Browse files
nejch
committed
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.
1 parent 5061972 commit cbd4d52

10 files changed

Lines changed: 19 additions & 12 deletions

File tree

‎ChangeLog.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Bug Fixes
2626
- Make MemberManager.all() return a list of objects
2727
- %d replaced by %s
2828
- Re-enable command specific help messages
29-
- dont ask for id attr if this is *Manager originating custom action
30-
- fix -/_ replacament for *Manager custom actions
29+
- dont ask for id attr if this is \*Manager originating custom action
30+
- fix -/_ replacament for \*Manager custom actions
3131
- fix repository_id marshaling in cli
3232
- register cli action for delete_in_bulk
3333

@@ -233,7 +233,7 @@ Version 1.2.0_ - 2018-01-01
233233
* Add support for features flags
234234
* Add support for project and group custom variables
235235
* Add support for user/group/project filter by custom attribute
236-
* Respect content of REQUESTS_CA_BUNDLE and *_proxy envvars
236+
* Respect content of REQUESTS_CA_BUNDLE and \*_proxy envvars
237237

238238
Version 1.1.0_ - 2017-11-03
239239
---------------------------

‎docs/api-objects.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ API examples
1515
gl_objects/messages
1616
gl_objects/commits
1717
gl_objects/deploy_keys
18+
gl_objects/deploy_tokens
1819
gl_objects/deployments
1920
gl_objects/discussions
2021
gl_objects/environments
@@ -34,8 +35,10 @@ API examples
3435
gl_objects/notes
3536
gl_objects/packages
3637
gl_objects/pagesdomains
38+
gl_objects/personal_access_tokens
3739
gl_objects/pipelines_and_jobs
3840
gl_objects/projects
41+
gl_objects/project_access_tokens
3942
gl_objects/protected_branches
4043
gl_objects/releases
4144
gl_objects/runners

‎docs/cli-usage.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ command line. This is handy for values containing new lines for instance:
403403
$ gitlab project create --name SuperProject --description @/tmp/description
404404
405405
Enabling shell autocompletion
406-
============================
406+
=============================
407407

408408
To get autocompletion, you'll need to install the package with the extra
409409
"autocompletion":

‎docs/gl_objects/deploy_tokens.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#######
1+
#############
22
Deploy tokens
3-
#######
3+
#############
44

55
Deploy tokens allow read-only access to your repository and registry images
66
without having a user and a password.

‎docs/gl_objects/milestones.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ List the merge requests related to a milestone::
7575
merge_requests = milestone.merge_requests()
7676

7777
Milestone events
78-
============
78+
================
7979

8080
Resource milestone events keep track of what happens to GitLab issues and merge requests.
8181

‎docs/gl_objects/mr_approvals.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Change MR-level MR approval rule::
7676
mr_approvalrule.save()
7777

7878
Create a MR-level MR approval rule::
79+
7980
mr.approval_rules.create({
8081
"name": "my MR custom approval rule",
8182
"approvals_required": 2,

‎docs/gl_objects/packages.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
#######
1+
########
22
Packages
3-
#######
3+
########
44

55
Packages allow you to utilize GitLab as a private repository for a variety
66
of common package managers.

‎docs/gl_objects/remote_mirrors.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##########
1+
######################
22
Project Remote Mirrors
3-
##########
3+
######################
44

55
Remote Mirrors allow you to set up push mirroring for a project.
66

‎docs/gl_objects/runners.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Verify a registered runner token::
7979
print("Invalid token")
8080

8181
Project/Group runners
82-
===============
82+
=====================
8383

8484
Reference
8585
---------

‎setup.cfg‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build_sphinx]
2+
warning-is-error = 1
3+
keep-going = 1

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL