Merge pull request #39458 from rallytime/fixup-more-doc-build-warnings

Fix more warnings in doc build
2024-11-07 08:58:59 +00:00 · 2017-02-16 14:45:51 -07:00 · 2017-02-16 14:45:51 -07:00 · e9b034f02f
commit e9b034f02f
parent e4f8c2bfb0 e698bc3508
12 changed files with 50 additions and 11 deletions
--- a/doc/topics/releases/2015.5.1.rst
+++ b/doc/topics/releases/2015.5.1.rst
@ -232,7 +232,7 @@ Extended Changelog Courtesy of Todd Stansell (https://github.com/tjstansell/salt
  - **ISSUE** `#23900`_: (*hashi825*) salt ubuntu network building issue 2015.5.0
    | refs: `#23922`_
  * b818f72 Merge pull request `#23922`_ from garethgreenaway/23900_2015_5_bonding_interface_fixes
-  * 0bba536 Fixing issue reported when using bonded interfaces on Ubuntu.  Attributes should be bond-, but the code was attempting to split just on bond_.  Fix accounts for both, but the debian_ip.py module will write out bond attributes with bond-
+  * 0bba536 Fixing issue reported when using bonded interfaces on Ubuntu.  Attributes should be bond-, but the code was attempting to split just on ``bond_``.  Fix accounts for both, but the debian_ip.py module will write out bond attributes with bond-

 - **PR** `#23925`_: (*jpic*) Fixed wrong path in LXC cloud documentation
  @ *2015-05-19T18:23:56Z*
--- a/doc/topics/releases/2015.5.11.rst
+++ b/doc/topics/releases/2015.5.11.rst
@ -113,7 +113,7 @@ Changes:

 * bbd8260 Ignore Raspbian in service.py __virtual__ (`#32421`_)

-* 690addf FreeBSD supports packages in format java/openjdk7 so the prior commit broke that functionality. Check freebsd/pkg`#1409`_ for more info.
+* 690addf FreeBSD supports packages in format java/openjdk7 so the prior commit broke that functionality. Check ``freebsd/pkg#1409`` for more info.

 - **PR** `#32399`_: (*amontalban*) Backport to fix `#28262`_ for 2015.5 as requested in PR `#32376`_

@ -289,6 +289,10 @@ Changes:

 - **PR** `#30291`_: (*thegoodduke*) ipset: fix test=true & add comment for every entry

+.. _`#23643`: https://github.com/saltstack/salt/issues/23643
+.. _`#23714`: https://github.com/saltstack/salt/issues/23714
+.. _`#28262`: https://github.com/saltstack/salt/issues/28262
+.. _`#31369`: https://github.com/saltstack/salt/issues/31369
 .. _`#24952`: https://github.com/saltstack/salt/pull/24952
 .. _`#26170`: https://github.com/saltstack/salt/pull/26170
 .. _`#26853`: https://github.com/saltstack/salt/pull/26853
--- a/doc/topics/releases/2015.5.5.rst
+++ b/doc/topics/releases/2015.5.5.rst
@ -2024,7 +2024,6 @@ Changes:
 .. _`fix-24036`: https://github.com/saltstack/salt/issues/24036
 .. _`fix-24272`: https://github.com/saltstack/salt/issues/24272
 .. _`fix-24483`: https://github.com/saltstack/salt/issues/24483
-.. _`fix-24484`: https://github.com/saltstack/salt/issues/24484
 .. _`fix-24882`: https://github.com/saltstack/salt/issues/24882
 .. _`fix-25192`: https://github.com/saltstack/salt/issues/25192
 .. _`fix-25616`: https://github.com/saltstack/salt/issues/25616
@ -2032,11 +2031,7 @@ Changes:
 .. _`#16049`: https://github.com/saltstack/salt/issues/16049
 .. _`#16179`: https://github.com/saltstack/salt/issues/16179
 .. _`#24334`: https://github.com/saltstack/salt/issues/24334
-.. _`#24484`: https://github.com/saltstack/salt/issues/24484
 .. _`#25562`: https://github.com/saltstack/salt/issues/25562
-.. _`#25801`: https://github.com/saltstack/salt/issues/25801
-.. _`#25998`: https://github.com/saltstack/salt/issues/25998
-.. _`#26000`: https://github.com/saltstack/salt/pull/26000
 .. _`#26155`: https://github.com/saltstack/salt/issues/26155
 .. _`#26160`: https://github.com/saltstack/salt/pull/26160
 .. _`#26161`: https://github.com/saltstack/salt/issues/26161
--- a/doc/topics/releases/2015.5.6.rst
+++ b/doc/topics/releases/2015.5.6.rst
@ -49,7 +49,7 @@ Changes:

 - **PR** `#27469`_: (*twangboy*) Added quotes to version numbers example

- **PR** `#27467`_: (*cachedout*) file.managed: check contents_{pillar|grain} result
+- **PR** `#27467`_: (*cachedout*) file.managed: check ``contents_{pillar|grain}`` result

 - **PR** `#27419`_: (*rallytime*) Amend error log to include multiple tips for troubleshooting.

@ -328,6 +328,7 @@ Changes:
 .. _`#26617`: https://github.com/saltstack/salt/pull/26617
 .. _`#26618`: https://github.com/saltstack/salt/pull/26618
 .. _`#26620`: https://github.com/saltstack/salt/pull/26620
+.. _`#26628`: https://github.com/saltstack/salt/issues/26628
 .. _`#26631`: https://github.com/saltstack/salt/pull/26631
 .. _`#26636`: https://github.com/saltstack/salt/pull/26636
 .. _`#26640`: https://github.com/saltstack/salt/pull/26640
@ -454,14 +455,17 @@ Changes:
 .. _`#27336`: https://github.com/saltstack/salt/pull/27336
 .. _`#27345`: https://github.com/saltstack/salt/pull/27345
 .. _`#27351`: https://github.com/saltstack/salt/pull/27351
+.. _`#27356`: https://github.com/saltstack/salt/issues/27356
 .. _`#27358`: https://github.com/saltstack/salt/pull/27358
 .. _`#27375`: https://github.com/saltstack/salt/pull/27375
 .. _`#27379`: https://github.com/saltstack/salt/pull/27379
+.. _`#27389`: https://github.com/saltstack/salt/issues/27389
 .. _`#27408`: https://github.com/saltstack/salt/pull/27408
 .. _`#27410`: https://github.com/saltstack/salt/pull/27410
 .. _`#27419`: https://github.com/saltstack/salt/pull/27419
 .. _`#27426`: https://github.com/saltstack/salt/pull/27426
 .. _`#27434`: https://github.com/saltstack/salt/pull/27434
+.. _`#27438`: https://github.com/saltstack/salt/issues/27438
 .. _`#27467`: https://github.com/saltstack/salt/pull/27467
 .. _`#27468`: https://github.com/saltstack/salt/pull/27468
 .. _`#27469`: https://github.com/saltstack/salt/pull/27469
--- a/doc/topics/releases/2015.5.7.rst
+++ b/doc/topics/releases/2015.5.7.rst
@ -210,6 +210,10 @@ Changes:

 - **PR** `#27568`_: (*jacobhammons*) regenerated man pages

+.. _`#19673`: https://github.com/saltstack/salt/issues/19673
+.. _`#25775`: https://github.com/saltstack/salt/issues/25775
+.. _`#28372`: https://github.com/saltstack/salt/issues/28372
+.. _`#28783`: https://github.com/saltstack/salt/issues/28783
 .. _`#29110`: https://github.com/saltstack/salt/issues/29110
 .. _`#25521`: https://github.com/saltstack/salt/pull/25521
 .. _`#25928`: https://github.com/saltstack/salt/pull/25928
--- a/doc/topics/releases/2015.5.8.rst
+++ b/doc/topics/releases/2015.5.8.rst
@ -242,7 +242,9 @@ Changes:

 - **PR** `#27568`_: (*jacobhammons*) regenerated man pages

+.. _`#19673`: https://github.com/saltstack/salt/issues/19673
 .. _`#25521`: https://github.com/saltstack/salt/pull/25521
+.. _`#25775`: https://github.com/saltstack/salt/issues/25775
 .. _`#25928`: https://github.com/saltstack/salt/pull/25928
 .. _`#27201`: https://github.com/saltstack/salt/pull/27201
 .. _`#27286`: https://github.com/saltstack/salt/pull/27286
@ -321,6 +323,7 @@ Changes:
 .. _`#28358`: https://github.com/saltstack/salt/pull/28358
 .. _`#28359`: https://github.com/saltstack/salt/pull/28359
 .. _`#28366`: https://github.com/saltstack/salt/pull/28366
+.. _`#28372`: https://github.com/saltstack/salt/issues/28372
 .. _`#28373`: https://github.com/saltstack/salt/pull/28373
 .. _`#28381`: https://github.com/saltstack/salt/pull/28381
 .. _`#28400`: https://github.com/saltstack/salt/pull/28400
@ -366,6 +369,7 @@ Changes:
 .. _`#28760`: https://github.com/saltstack/salt/pull/28760
 .. _`#28776`: https://github.com/saltstack/salt/pull/28776
 .. _`#28777`: https://github.com/saltstack/salt/pull/28777
+.. _`#28783`: https://github.com/saltstack/salt/issues/28783
 .. _`#28786`: https://github.com/saltstack/salt/pull/28786
 .. _`#28826`: https://github.com/saltstack/salt/pull/28826
 .. _`#28829`: https://github.com/saltstack/salt/pull/28829
--- a/doc/topics/releases/2015.8.0.rst
+++ b/doc/topics/releases/2015.8.0.rst
@ -108,6 +108,8 @@ Using the new features will require updates to the git ext_pillar
 configuration, further details can be found in the :ref:`pillar.git_pillar
 <git-pillar-2015-8-0-and-later>` docs.

+.. _pygit2: https://github.com/libgit2/pygit2
+
 Salt Cloud Improvements
 =======================

--- a/doc/topics/releases/2015.8.1.rst
+++ b/doc/topics/releases/2015.8.1.rst
@ -409,6 +409,7 @@ Changes:
 .. _`#27210`: https://github.com/saltstack/salt/pull/27210
 .. _`#27213`: https://github.com/saltstack/salt/pull/27213
 .. _`#27214`: https://github.com/saltstack/salt/pull/27214
+.. _`#27217`: https://github.com/saltstack/salt/issues/27217
 .. _`#27218`: https://github.com/saltstack/salt/pull/27218
 .. _`#27223`: https://github.com/saltstack/salt/pull/27223
 .. _`#27230`: https://github.com/saltstack/salt/pull/27230
--- a/doc/topics/releases/2015.8.2.rst
+++ b/doc/topics/releases/2015.8.2.rst
@ -565,12 +565,19 @@ Changes:

 - **PR** `#27585`_: (*ryan-lane*) Fix undefined variable in cron state module

+.. _`#3436`: https://github.com/saltstack/salt/issues/3436
+.. _`#8646`: https://github.com/saltstack/salt/issues/8646
+.. _`#12363`: https://github.com/saltstack/salt/issues/12363
+.. _`#13513`: https://github.com/saltstack/salt/issues/13513
+.. _`#13850`: https://github.com/saltstack/salt/issues/13850
+.. _`#20678`: https://github.com/saltstack/salt/issues/20678
 .. _`#29110`: https://github.com/saltstack/salt/issues/29110
 .. _`#22115`: https://github.com/saltstack/salt/pull/22115
 .. _`#25315`: https://github.com/saltstack/salt/pull/25315
 .. _`#25521`: https://github.com/saltstack/salt/pull/25521
 .. _`#25668`: https://github.com/saltstack/salt/pull/25668
 .. _`#25928`: https://github.com/saltstack/salt/pull/25928
+.. _`#26336`: https://github.com/saltstack/salt/issues/26336
 .. _`#26945`: https://github.com/saltstack/salt/pull/26945
 .. _`#27099`: https://github.com/saltstack/salt/pull/27099
 .. _`#27116`: https://github.com/saltstack/salt/pull/27116
@ -679,6 +686,7 @@ Changes:
 .. _`#27809`: https://github.com/saltstack/salt/pull/27809
 .. _`#27816`: https://github.com/saltstack/salt/pull/27816
 .. _`#27824`: https://github.com/saltstack/salt/pull/27824
+.. _`#27825`: https://github.com/saltstack/salt/issues/27825
 .. _`#27826`: https://github.com/saltstack/salt/pull/27826
 .. _`#27827`: https://github.com/saltstack/salt/pull/27827
 .. _`#27833`: https://github.com/saltstack/salt/pull/27833
@ -887,6 +895,7 @@ Changes:
 .. _`#28465`: https://github.com/saltstack/salt/pull/28465
 .. _`#28472`: https://github.com/saltstack/salt/pull/28472
 .. _`#28473`: https://github.com/saltstack/salt/pull/28473
+.. _`#28484`: https://github.com/saltstack/salt/issues/28484
 .. _`#28485`: https://github.com/saltstack/salt/pull/28485
 .. _`#28486`: https://github.com/saltstack/salt/pull/28486
 .. _`#28487`: https://github.com/saltstack/salt/pull/28487
@ -903,6 +912,8 @@ Changes:
 .. _`#28516`: https://github.com/saltstack/salt/pull/28516
 .. _`#28517`: https://github.com/saltstack/salt/pull/28517
 .. _`#28525`: https://github.com/saltstack/salt/pull/28525
+.. _`#28526`: https://github.com/saltstack/salt/issues/28526
+.. _`#28527`: https://github.com/saltstack/salt/issues/28527
 .. _`#28529`: https://github.com/saltstack/salt/pull/28529
 .. _`#28530`: https://github.com/saltstack/salt/pull/28530
 .. _`#28531`: https://github.com/saltstack/salt/pull/28531
--- a/doc/topics/releases/2015.8.3.rst
+++ b/doc/topics/releases/2015.8.3.rst
@ -672,6 +672,12 @@ Changes:

 - **PR** `#27585`_: (*ryan-lane*) Fix undefined variable in cron state module

+.. _`#3436`: https://github.com/saltstack/salt/issues/3436
+.. _`#8646`: https://github.com/saltstack/salt/issues/8646
+.. _`#12363`: https://github.com/saltstack/salt/issues/12363
+.. _`#13513`: https://github.com/saltstack/salt/issues/13513
+.. _`#13850`: https://github.com/saltstack/salt/issues/13850
+.. _`#20678`: https://github.com/saltstack/salt/issues/20678
 .. _`#22115`: https://github.com/saltstack/salt/pull/22115
 .. _`#24314`: https://github.com/saltstack/salt/pull/24314
 .. _`#25315`: https://github.com/saltstack/salt/pull/25315
@ -681,6 +687,7 @@ Changes:
 .. _`#25923`: https://github.com/saltstack/salt/pull/25923
 .. _`#25928`: https://github.com/saltstack/salt/pull/25928
 .. _`#25946`: https://github.com/saltstack/salt/pull/25946
+.. _`#26336`: https://github.com/saltstack/salt/issues/6336
 .. _`#26945`: https://github.com/saltstack/salt/pull/26945
 .. _`#27099`: https://github.com/saltstack/salt/pull/27099
 .. _`#27116`: https://github.com/saltstack/salt/pull/27116
@ -789,6 +796,7 @@ Changes:
 .. _`#27809`: https://github.com/saltstack/salt/pull/27809
 .. _`#27816`: https://github.com/saltstack/salt/pull/27816
 .. _`#27824`: https://github.com/saltstack/salt/pull/27824
+.. _`#27825`: https://github.com/saltstack/salt/issues/27825
 .. _`#27826`: https://github.com/saltstack/salt/pull/27826
 .. _`#27827`: https://github.com/saltstack/salt/pull/27827
 .. _`#27833`: https://github.com/saltstack/salt/pull/27833
@ -997,6 +1005,7 @@ Changes:
 .. _`#28465`: https://github.com/saltstack/salt/pull/28465
 .. _`#28472`: https://github.com/saltstack/salt/pull/28472
 .. _`#28473`: https://github.com/saltstack/salt/pull/28473
+.. _`#28484`: https://github.com/saltstack/salt/issues/28484
 .. _`#28485`: https://github.com/saltstack/salt/pull/28485
 .. _`#28486`: https://github.com/saltstack/salt/pull/28486
 .. _`#28487`: https://github.com/saltstack/salt/pull/28487
@ -1013,6 +1022,8 @@ Changes:
 .. _`#28516`: https://github.com/saltstack/salt/pull/28516
 .. _`#28517`: https://github.com/saltstack/salt/pull/28517
 .. _`#28525`: https://github.com/saltstack/salt/pull/28525
+.. _`#28526`: https://github.com/saltstack/salt/issues/28526
+.. _`#28527`: https://github.com/saltstack/salt/issues/28527
 .. _`#28529`: https://github.com/saltstack/salt/pull/28529
 .. _`#28530`: https://github.com/saltstack/salt/pull/28530
 .. _`#28531`: https://github.com/saltstack/salt/pull/28531
@ -1099,6 +1110,7 @@ Changes:
 .. _`#28744`: https://github.com/saltstack/salt/pull/28744
 .. _`#28746`: https://github.com/saltstack/salt/pull/28746
 .. _`#28752`: https://github.com/saltstack/salt/pull/28752
+.. _`#28754`: https://github.com/saltstack/salt/issues/28754
 .. _`#28755`: https://github.com/saltstack/salt/pull/28755
 .. _`#28756`: https://github.com/saltstack/salt/pull/28756
 .. _`#28757`: https://github.com/saltstack/salt/pull/28757
@ -1114,6 +1126,7 @@ Changes:
 .. _`#28777`: https://github.com/saltstack/salt/pull/28777
 .. _`#28778`: https://github.com/saltstack/salt/pull/28778
 .. _`#28782`: https://github.com/saltstack/salt/pull/28782
+.. _`#28784`: https://github.com/saltstack/salt/pull/issues/28784
 .. _`#28786`: https://github.com/saltstack/salt/pull/28786
 .. _`#28787`: https://github.com/saltstack/salt/pull/28787
 .. _`#28789`: https://github.com/saltstack/salt/pull/28789
@ -1199,6 +1212,7 @@ Changes:
 .. _`#29095`: https://github.com/saltstack/salt/pull/29095
 .. _`#29096`: https://github.com/saltstack/salt/pull/29096
 .. _`#29097`: https://github.com/saltstack/salt/pull/29097
+.. _`#29107`: https://github.com/saltstack/salt/issues/29107
 .. _`#29108`: https://github.com/saltstack/salt/pull/29108
 .. _`#29113`: https://github.com/saltstack/salt/pull/29113
 .. _`#29118`: https://github.com/saltstack/salt/pull/29118
--- a/doc/topics/releases/2016.11.3.rst
+++ b/doc/topics/releases/2016.11.3.rst
@ -6,7 +6,7 @@ Version 2016.11.3 is a bugfix release for :ref:`2016.11.0 <release-2016-11-0>`.


 Changes for v2016.11.2..v2016.11.3
----------------------------------------------------------------
+----------------------------------

 Extended changelog courtesy of Todd Stansell (https://github.com/tjstansell/salt-changelogs):

@ -691,7 +691,7 @@ Changes:
  * f8a6863 Merge pull request `#39087`_ from lomeroe/`bp-37375`_
  * c3aaa53 _in_range_inclusive class method incorrectly called isinstance

-  * ce263f9 set_computer_policy and set_user_policy call "set" by the original function name (set) instead of the aliased function name set_
+  * ce263f9 set_computer_policy and set_user_policy call "set" by the original function name (set) instead of the aliased function name ``set_``

  * ff7d74b correct tool extension guid for user registry policies

--- a/doc/topics/releases/2016.3.5.rst
+++ b/doc/topics/releases/2016.3.5.rst
@ -1796,7 +1796,7 @@ Changes:
 - **PR** `#37447`_: (*rallytime*) Cast ip_protocol rule as a str() in boto_secgroup.present
  @ *2016-11-04T04:03:45Z*

-  - **ISSUE** `#36961`_: (*nullify005*) boto_secgroup assumes a string when checking ip_protocol validity when not tcp|udp|all|-1
+  - **ISSUE** `#36961`_: (*nullify005*) boto_secgroup assumes a string when checking ip_protocol validity when not ``tcp|udp|all|-1``
    | refs: `#37447`_
  * 651e0f7 Merge pull request `#37447`_ from rallytime/`fix-36961`_
  * 6b930ac Cast ip_protocol rule as a str() in boto_secgroup.present