Skip to content

docs: fail on warnings during sphinx build #1441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ChangeLog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Bug Fixes
- Make MemberManager.all() return a list of objects
- %d replaced by %s
- Re-enable command specific help messages
- dont ask for id attr if this is *Manager originating custom action
- fix -/_ replacament for *Manager custom actions
- dont ask for id attr if this is \*Manager originating custom action
- fix -/_ replacament for \*Manager custom actions
- fix repository_id marshaling in cli
- register cli action for delete_in_bulk

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

Version 1.1.0_ - 2017-11-03
---------------------------
Expand Down
3 changes: 3 additions & 0 deletions docs/api-objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/cli-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
4 changes: 2 additions & 2 deletions docs/gl_objects/deploy_tokens.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/gl_objects/milestones.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions docs/gl_objects/mr_approvals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions docs/gl_objects/packages.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#######
########
Packages
#######
########

Packages allow you to utilize GitLab as a private repository for a variety
of common package managers.
Expand Down
4 changes: 2 additions & 2 deletions docs/gl_objects/remote_mirrors.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
##########
######################
Project Remote Mirrors
##########
######################

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

Expand Down
2 changes: 1 addition & 1 deletion docs/gl_objects/runners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Verify a registered runner token::
print("Invalid token")

Project/Group runners
===============
=====================

Reference
---------
Expand Down
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build_sphinx]
warning-is-error = 1
keep-going = 1