Commit Graph

9236 Commits

Author SHA1 Message Date
Tyler Johnson
2867d07434
Added refs to AIX module documentation 2019-06-04 13:04:16 -06:00
Erik Johnson
6db2beb6c0
Replace "pchanges" with "changes" to fix onchanges/prereq requisites
Since "pchanges" was never supported in the state compiler, and
"changes" is what these reqs always used, replacing "pchanges" with
"changes" will allow those requisites to work in test mode.

Conflicts:
  - salt/states/file.py
  - salt/states/linux_acl.py
  - salt/utils/napalm.py
  - tests/integration/modules/test_state.py
  - tests/unit/states/test_file.py
2019-04-18 10:56:30 -04:00
Dmitry Kuzmenko
7f26e764fc
Revert "Update doc conf with the new import tornado.queues"
This reverts commit 684bf584f6.
2019-04-17 02:00:22 +03:00
Daniel Wozniak
6eb2bce9be
Merge pull request #52334 from waynew/51879-fix-binary-pillar-return-error
51879 fix binary pillar return error
2019-04-11 20:45:16 -07:00
Daniel Wozniak
ead856ee93
Merge branch '2019.2' into 51879-fix-binary-pillar-return-error 2019-04-11 16:33:20 -07:00
Gareth J. Greenaway
b191bc0d58
Merge branch '2019.2' into 52350_readd_and_gate_unicode_string_literal_support 2019-04-08 08:30:41 -07:00
Megan Wilhite
a4a552191a
Merge branch '2019.2' into patch-2 2019-04-05 17:41:55 -04:00
Gareth J. Greenaway
f848aa474d
Adding support back in with, a gated configuration option, for the old YAML Loader. 2019-04-05 11:31:03 -07:00
Ch3LL
63962b547a
Merge branch '2018.3' into '2019.2'
Conflicts:
  - salt/states/linux_acl.py
  - salt/transport/ipc.py
2019-03-28 11:10:45 -04:00
Megan Wilhite
bda3ca2071
Merge pull request #51749 from terminal-labs/salt-cloud-map-alt-update
Salt cloud map alt update
2019-03-28 09:52:26 -04:00
Daniel Wozniak
14a6b9d417
Merge pull request #52306 from terminal-labs/replace-ping-with-version
Replaced `test.ping` with `test.version`
2019-03-27 15:50:06 -07:00
Dmitry Kuzmenko
cc46e9c498
Merge branch '2018.3' into bugs/49147_ipc_subscriber 2019-03-27 23:37:31 +03:00
Alan Cugler
9ca0f72308 Changed where to mention the map files compatibility for minion configuration options.
This is a result of @Ch3LL suggestion on the PR itself for this doc change.
2019-03-27 12:42:03 -05:00
Alan Cugler
364ef065e8 Added mention of map file alternative for minion configuration options.
Fixes: #51127
2019-03-27 12:42:03 -05:00
Megan Wilhite
8255901b33 document regex_replace Jinja filter (#52326)
Fixes #48952.
2019-03-27 10:14:07 -06:00
Wayne Werner
fb010c0a6e
Add binary pillar to the docs 2019-03-26 19:58:29 -05:00
Alan Cugler
c04ba6e35e
Changed a text artifact from the ping function to supporting text for the version function. 2019-03-26 09:58:26 -05:00
Alan Cugler
e8c8dba161
Added in an explaination of the --zone flag
approved in #52251
2019-03-25 16:10:29 -05:00
Gareth J. Greenaway
11cd485a8b
Merge branch '2018.3' into merge-2019.2
Conflicts:
   - doc/topics/installation/freebsd.rst
2019-03-25 13:42:28 -07:00
Alan Cugler
0b1eb00dc4
Replaced test.ping with test.version
Result of issue #52277

Any where `test.ping` still exists in the docs was left
because of the context in those docs.
2019-03-25 12:09:48 -05:00
Gareth J. Greenaway
68c02b9c34
Merge branch '2019.2' into merge-2019.2 2019-03-22 17:36:18 -07:00
Shane Lee
d1308324a3
Merge branch '2019.2' into patch-2 2019-03-22 18:08:36 -06:00
Megan Wilhite
34d601e902
Merge branch '2019.2' into merge-2019.2 2019-03-22 16:38:07 -04:00
Gareth J. Greenaway
a2fbbe05e1
Merge branch '2018.3' into replace-github-dead-link 2019-03-22 11:55:43 -07:00
Gareth J. Greenaway
08728cf660
Merge branch '2018.3' into replace-github-dead-link 2019-03-22 11:32:15 -07:00
Akmod
ca00e4bf20 Merge branch '2018.3' of github.com:saltstack/salt into doc_fix 2019-03-22 11:29:54 -06:00
Akmod
8e1ec15c39 Add missing master/minion docs for log_rotate*
Adds log_rotate_backup_count and log_rotate_max_bytes to the
minion and master config documentation
Solves issue: #51921
2019-03-22 11:26:01 -06:00
Dmitry Kuzmenko
2bc2a7d83e
Merge branch '2018.3' into bugs/49147_ipc_subscriber 2019-03-22 18:02:55 +03:00
Megan Wilhite
f63bae987d
Merge branch '2019.2' into rn_update 2019-03-21 11:24:36 -04:00
Dmitry Kuzmenko
684bf584f6
Update doc conf with the new import tornado.queues 2019-03-20 21:04:49 +03:00
Søren Skov Eriksen
5db7a3f2df
Fix Typos "swtich" to "switch" 2019-03-19 13:59:36 +01:00
Alan Cugler
62e54044fc
github issue tracker link and sends you to the url for listed issues. 2019-03-18 16:18:40 -05:00
Alan Cugler
842ec84186
Merge branch '2018.3' into docs-sphinx-ref-deadlink-fix 2019-03-18 14:32:32 -05:00
Gareth J. Greenaway
f68caa633f
Merge branch '2018.3' into bp-47005 2019-03-15 18:09:24 -07:00
Megan Wilhite
d1700f3afc
Merge branch '2018.3' into bp-47005 2019-03-15 12:03:50 -04:00
Max Arnold
75acce19f1 Rename obsolete beacon validation function 2019-03-15 18:28:12 +07:00
Ch3LL
25ae7c8873
remove freebsd-upstream reference 2019-03-14 17:41:21 -04:00
Ari Maniatis
b70c45c297
Remove salt FreeBSD repo which is now 2 years out of date
The saltstack repository has the 2016 version is current. Its not being updated, but there is a perfectly good port in the FreeBSD tree to use instead. Enhance the documentation on how to install that from binary or source.
2019-03-14 17:40:18 -04:00
Ch3LL
9ada8d9b7f
Merge branch '2018.3' into '2019.2'
Conflicts:
  - salt/transport/zeromq.py
  - tests/unit/modules/test_kubernetesmod.py
  - tests/unit/modules/test_win_file.py
2019-03-14 16:13:54 -04:00
Simon Flood
3d3110267d
Fix typo in actual 2019.2.0 release notes
See #51861
2019-03-12 11:49:29 +00:00
Ch3LL
8a8a5fa89d
Add azure module ref pages and fix doc errors 2019-03-08 17:31:15 -05:00
Ch3LL
7ad4758f6f
Update device names in proxy getting started docs 2019-03-08 12:51:08 -05:00
Megan Wilhite
e2c3f93bd2
Merge branch '2019.2' into rn_update 2019-03-08 10:45:40 -05:00
Megan Wilhite
92dbe2af78
Merge branch '2019.2' into fix_azure_docs 2019-03-08 10:30:08 -05:00
Ch3LL
af0537fa39
Add azure state and execution modules to doc index 2019-03-07 12:00:08 -05:00
Megan Wilhite
b217f948ee
Merge branch '2018.3' into py3_doc 2019-03-07 10:59:51 -05:00
Ch3LL
605bfaf7c5
Update futures dependency for python2 only 2019-03-07 10:59:01 -05:00
Megan Wilhite
164398f68e
Merge branch '2019.2' into rn_update 2019-03-07 10:54:03 -05:00
Megan Wilhite
54ea40a265
Merge branch '2019.2' into merge-2019.2 2019-03-07 10:38:23 -05:00
Gareth J. Greenaway
faa3471c05
Merge branch '2018.3' into 2018.3 2019-03-05 17:42:18 -08:00
Ch3LL
a16891347c
Merge branch '2018.3' into '2019.2'
Conflicts:
  - doc/conf.py
  - salt/modules/win_system.py
  - salt/states/boto3_route53.py
2019-03-05 16:00:05 -05:00
Bryce Larson
ecf0ef00b8
Fix typo in 2019.2.0 release notes 2019-03-05 13:13:24 -07:00
Ch3LL
9adc19eeb1
Merge branch '2017.7' into '2018.3'
Conflicts:
 - doc/conf.py
 - salt/modules/zfs.py
2019-03-05 14:08:35 -05:00
Megan Wilhite
c04b2a09f3
Merge branch '2019.2' into rn_update 2019-03-05 11:34:58 -05:00
Denys Havrysh
9ca6e503b9
Update doc/topics/releases/2019.2.0.rst
Co-Authored-By: Ch3LL <megan.wilhite@gmail.com>
2019-03-05 11:34:33 -05:00
Denys Havrysh
052f193f1c
add additional formatting to 2019.2.0 release notes
Co-Authored-By: Ch3LL <megan.wilhite@gmail.com>
2019-03-05 10:17:54 -05:00
Daniel Wozniak
92752071c4
Merge branch '2017.7' into docs-sphinx-ref-deadlink-fix 2019-03-05 03:08:36 -07:00
Daniel Wozniak
f867e6e565
Merge pull request #51761 from sdodsley/cheery_pick_fb_releasenotes
Add new module to release notes for 2019.2.0
2019-03-05 02:44:55 -07:00
Daniel Wozniak
a6891778ec
Merge pull request #51807 from Ch3LL/2018.3.5_rn
Add 2018.3.5 release notes
2019-03-05 02:27:23 -07:00
Daniel Wozniak
ff5d7d6e59
Merge pull request #51810 from Ch3LL/2019.2.1_rn
Add 2019.2.1 release notes
2019-03-05 02:26:46 -07:00
Ch3LL
a6ca59a1a2
Update 2019.2.0 release notes with other tojson example 2019-03-04 14:49:40 -05:00
Daniel Wallace
1e7490c458
update kubernetesmod in index.rst 2019-03-01 13:52:27 -06:00
Daniel Wallace
8572c17091
rename kubernetes module to kubernetesmod
This makes sure this doesn't import the kubernetes module from
salt/modules while the kubernetes python module is not installed
2019-03-01 13:33:50 -06:00
Ch3LL
072cd84c7d
Update supported python versions in installation docs 2019-03-01 14:29:50 -05:00
Ch3LL
9a681367a6
Update release documentation 2019-03-01 10:21:02 -05:00
Ch3LL
502d197f84
fix spelling error in release notes 2019-02-27 14:04:41 -05:00
Ch3LL
4d53b41740
Add new terraform salt-ssh roster feature to release notes 2019-02-27 14:00:07 -05:00
Ch3LL
aaee5fa0b7
Add 2019.2.1 release notes 2019-02-25 16:38:16 -05:00
Ch3LL
2c0b85c8f6
Add 2018.3.5 release notes 2019-02-25 16:31:34 -05:00
Megan Wilhite
27dd9fbac2
Merge pull request #51772 from Ch3LL/doc_conf_2019
Update release versions for the 2019.2 branch
2019-02-25 09:16:39 -05:00
Megan Wilhite
864d4be0c3
Merge pull request #51770 from Ch3LL/doc_conf_2017
Update release versions for the 2017.7 branch
2019-02-25 09:11:22 -05:00
Gareth J. Greenaway
186306a80c
reverting change in release notes, adding change to doc/ref/modules/all/index.rst. 2019-02-23 17:20:46 -08:00
Gareth J. Greenaway
1ef140a366
Fixing lint. 2019-02-23 15:19:19 -08:00
Gareth J. Greenaway
e37fc20e7c
Merge branch '2018.3' into merge-2018.3
Conflicts:
  - doc/ref/modules/all/index.rst
  - salt/states/file.py
  - tests/unit/modules/test_yumpkg.py
  - tests/unit/modules/test_zypperpkg.py
  - tests/unit/states/test_file.py
2019-02-22 16:38:15 -08:00
Alan Cugler
1f00c89fca
Added in python 3 server according to the consensus from #51748 2019-02-22 15:22:10 -06:00
Ch3LL
f28cc9bff1
[2019.2] change build_type and release in doc/conf.py 2019-02-22 15:26:16 -05:00
Ch3LL
904beb3548
[2018.3] change build_type and release in doc/conf.py 2019-02-22 15:18:33 -05:00
Ch3LL
4c670e2e62
Update release versions for the 2019.2 branch 2019-02-22 15:02:48 -05:00
Ch3LL
3efcea50f1
Update release versions for the 2018.3 branch 2019-02-22 15:01:24 -05:00
Ch3LL
25d9ca24d7
Update release versions for the 2017.7 branch 2019-02-22 14:57:22 -05:00
Alan Cugler
2330c2ac7b
makefile had an old sphinx-doc link, updated to new general front page of sphinx docs. 2019-02-22 11:31:35 -06:00
Alan Cugler
8d70e3bbb5
Replaced all bad sphinx links with ones from the new sphinx doc site. 2019-02-22 11:27:47 -06:00
Simon Dodsley
80192c80fa Add new module to release notes for 2019.2.0 2019-02-22 08:18:13 -05:00
Alan Cugler
ebdffcdc42
replaced two python sphinx deadlinks with sphinx new relevant
documentation pages.
2019-02-21 14:42:47 -06:00
Alan Cugler
ccf6a06c7e
Replaced a dead link for github issue tracker with another github
link for the issue tracker and added a link to show more options
for closing issues in commit messages.
2019-02-21 14:13:24 -06:00
Alan Cugler
bfb9d87af7 added the python3 command for startign the python http server. 2019-02-21 12:20:08 -06:00
Daniel Wallace
33bb5bfe69
fix use of virtualname
Make sure that the virtualname is included in the actual filename of
core modules.  This will help speed up loading of modules that need to
use the virtualname, so that we hit @depends decorators less.
2019-02-19 13:16:06 -06:00
Ch3LL
ffa2f5fa50
Merge branch '2018.3' into '2019.2'
Conflicts:
  - pkg/windows/build_env_2.ps1
  - pkg/windows/build_env_3.ps1
  - pkg/windows/req.txt
  - pkg/windows/req_win.txt
  - salt/grains/core.py
2019-02-15 15:09:36 -05:00
Daniel Wozniak
e3d5fbe947
Merge pull request #51577 from garethgreenaway/merge-2017.7
[2018.3] Merge forward from 2017.7 to 2018.3
2019-02-13 01:11:10 -07:00
Daniel Wozniak
5bb9b323fe
Merge pull request #51393 from garethgreenaway/various_documentation_fixes
[2018.3] Various documentation fixes
2019-02-12 22:34:55 -07:00
Daniel Wozniak
e060b979a4
Merge branch '2018.3' into merge-2017.7 2019-02-12 17:56:53 -07:00
Erik Johnson
24aa083c65
Merge pull request #51598 from terminalmage/add-grain-option-documentation
Add documentation for the metadata_server_grains config option
2019-02-12 15:23:36 -06:00
Erik Johnson
9c02104fea
Add link to metadata grain module docs 2019-02-12 09:01:19 -06:00
Erik Johnson
997ce2650c
Add documentation for the metadata_server_grains config option 2019-02-12 08:56:48 -06:00
Gareth J. Greenaway
6c99cb161f
Merge branch '2018.3' into merge-2018.3
Conflicts:
	doc/man/salt-api.1
	doc/man/salt-call.1
	doc/man/salt-cloud.1
	doc/man/salt-cp.1
	doc/man/salt-key.1
	doc/man/salt-master.1
	doc/man/salt-minion.1
	doc/man/salt-proxy.1
	doc/man/salt-run.1
	doc/man/salt-ssh.1
	doc/man/salt-syndic.1
	doc/man/salt-unity.1
	doc/man/salt.1
	doc/man/salt.7
	doc/man/spm.1
	pkg/osx/build_env.sh
	salt/utils/dns.py
	tests/integration/netapi/rest_tornado/test_app.py
	tests/support/case.py
	tests/unit/utils/test_dns.py
2019-02-11 15:45:43 -08:00
Gareth J. Greenaway
c337fcee4c
Merge branch '2018.3' into merge-2017.7 2019-02-11 14:51:33 -08:00
Gareth J. Greenaway
e891b3f515
Merge branch '2018.3.4' into merge-2018.3.4
Conflicts:
	tests/integration/states/test_file.py
	tests/unit/states/test_file.py
	tests/unit/utils/test_dns.py
2019-02-11 10:46:53 -08:00
Gareth J. Greenaway
a04177518f
Merge branch '2017.7' into merge-2017.7
Conflicts:
	salt/modules/pillar.py
	salt/states/pip_state.py
	salt/utils/data.py
	tests/unit/modules/inspectlib/test_fsdb.py
	tests/unit/output/test_json_out.py
	tests/unit/test_test_module_names.py
2019-02-11 09:01:46 -08:00
Daniel Wozniak
8bb7535888
Merge branch '2018.3' into various_documentation_fixes 2019-02-08 11:23:24 -07:00
Frode Gundersen
c6bfe53e8b
2018.3.4 releasenotes 2019-02-06 22:29:56 +00:00
Frode Gundersen
fb678ee990
fix escaped asterisks 2019-02-06 22:08:37 +00:00
Frode Gundersen
6a4f0da96b
2018.3.4 releasenotes 2019-02-06 21:10:51 +00:00
Mathieu Parent
7ca2aa4919
Allow dynamic file_roots
Fixes: #48132
2019-02-06 21:33:11 +01:00
Frode Gundersen
0cbe3f8bb5
Update man pages for 2018.3.4 2019-02-06 17:35:33 +00:00
Daniel Wozniak
c3e27bef82
Merge pull request #51405 from aplanas/backport_49669
Documentation: fix typo in "equivalent"
2019-02-01 14:11:11 -07:00
Gareth J. Greenaway
3582f6e209
Fixing the underline. 2019-01-31 10:30:58 -08:00
Gareth J. Greenaway
a8f42a0d42
Various documentation fixes. 2019-01-31 10:30:57 -08:00
Alberto Planas
e61a0779d4 states_pt3: fix rST link format
(cherry picked from commit f6ae0123e1)
2019-01-31 10:53:54 +01:00
Alberto Planas
58279b4211 Documentation: fix typo in "equivalent"
(cherry picked from commit a91676c2d5)
2019-01-31 10:53:14 +01:00
Ch3LL
25ec653fd4
Merge branch '2018.3' into '2019.2'
Conflicts:
  - .codecov.yml
  - salt/modules/artifactory.py
2019-01-25 13:19:07 -05:00
Thomas S Hatch
f6a7cad822
Merge pull request #51225 from astronouth7303/loader-docs-2018.3
Loader docs 2018.3
2019-01-22 15:18:47 -07:00
Megan Wilhite
276d621799
Merge pull request #51197 from Ch3LL/tag_manager
Add Google Tag Manager to Docs
2019-01-22 14:08:47 -05:00
Erik Johnson
41ae39067e
Merge pull request #51231 from terminalmage/issue51056
Clarify documentation for the the gitfs "all_saltenvs" config param
2019-01-22 11:33:19 -06:00
Gareth J. Greenaway
d0d5726ffa
Merge branch '2018.3' into merge-2019.2 2019-01-22 09:20:42 -08:00
Gareth J. Greenaway
827d6c3722
Merge branch '2018.3' into tag_manager 2019-01-18 11:54:43 -08:00
Kavya Chandrashekhar
e4afc814e1 Addressing Megan's comment to fix the py2.7 deprecation message in release notes 2019-01-17 17:05:57 -07:00
Kavya Chandrashekhar
8ec0296986 Added a note in Release notes about py 2.7 EOL 2019-01-17 15:39:32 -07:00
Erik Johnson
4a614775e4
Clarify documentation for the the gitfs "all_saltenvs" config param 2019-01-17 16:02:21 -06:00
Ch3LL
0ef76755db
Merge branch '2017.7' into '2018.3'
Conflicts:
  - salt/modules/capirca_acl.py
2019-01-17 16:11:12 -05:00
Jamie Bliss
1945c30feb
Document the client-defined dunders 2019-01-17 15:28:59 -05:00
Jamie Bliss
6e7da9577d
Add the tokens system.
Also update the no-fs flag on the thorium system.
2019-01-17 14:56:44 -05:00
Jamie Bliss
7e2838ca92
Add reference to the execution module docs 2019-01-17 14:16:51 -05:00
Jamie Bliss
f30f9e81e7
Remove search system 2019-01-17 14:08:23 -05:00
Jamie Bliss
f0cc183823
Fileserver modules can be loaded from the fileserver. 2019-01-17 14:07:25 -05:00
Ch3LL
810c6119ec
Merge branch '2019.2.0.rc1' into 2019.2 2019-01-16 16:38:32 -05:00
Ch3LL
fcdfe6943f
Add Google Tag Manager to Docs 2019-01-16 15:30:45 -05:00
Daniel Wozniak
3f4759b8bf
Merge pull request #50923 from astronouth7303/patch-2
Document {% include %}
2019-01-15 09:39:11 -07:00
Max Arnold
2f8e391279
Fix profile outputter docs
Also remove the mention of obsolete "grains" output format.
2019-01-14 15:14:07 -05:00
Gareth J. Greenaway
83c3755b4f
Merge branch '2019.2.0.rc1' into update_branch_ref 2019-01-08 21:49:52 -08:00
Ch3LL
e9114a6544
Add 2019.2 to toctree 2019-01-08 15:20:46 -05:00
Ch3LL
c3f4a701d4
remove unnecessary space to fix doc warning 2019-01-08 14:55:42 -05:00
Ch3LL
09dd1cba8d
Update Fluorine references to 2019.2.0 2019-01-08 14:55:42 -05:00
Ch3LL
3a85c5b33f
Update man pages for 2019.2.0 2019-01-08 14:35:36 -05:00
Daniel Wozniak
9d4321ddac
Merge pull request #50878 from max-arnold/output-docs
Fix profile outputter docs
2019-01-08 11:32:39 -07:00
Gareth J. Greenaway
2ea7404d73
Merge branch '2018.3' into merge-fluorine
Conflicts:
	salt/modules/aptpkg.py
2019-01-07 10:04:56 -08:00
Gareth J. Greenaway
12f75834aa
Merge branch '2017.7' into merge-2018.3
Conflicts:
   - pkg/osx/req.txt
   - pkg/windows/req.txt
2019-01-01 13:35:41 -08:00
Gareth J. Greenaway
f8d8bcd0d2
Fixing failing doc build tests. 2018-12-26 15:33:16 -08:00
rallytime
43c39e7408
Add documentation to master config docs for job_cache_store_endtime 2018-12-24 14:22:25 -05:00
rallytime
887cd070ca
Add some salt-api options to the master config docs 2018-12-24 14:22:25 -05:00
rallytime
0d49746de8
Fix some formatting in master config docs 2018-12-24 14:22:24 -05:00
Gareth J. Greenaway
490a39dda5
Adding missing line back into doc/conf.py 2018-12-21 08:29:30 -08:00
Gareth J. Greenaway
9c04986641
Merge branch '2018.3' into merge-fluorine
Conflicts:
	doc/conf.py
	doc/topics/development/dunder_dictionaries.rst
	salt/client/ssh/ssh_py_shim.py
	salt/grains/core.py
	salt/modules/mysql.py
	salt/modules/state.py
2018-12-20 17:20:42 -08:00
Ch3LL
1f01489017
Fix external_pillars documentation 2018-12-20 11:05:43 -05:00
Jamie Bliss
4f631a6f8b
Document {% include %}
Mention that jinja includes need to use the full path and cannot use relative paths.
2018-12-19 16:11:28 -05:00
Benjamin Drung
ecdb452e8a doc: Indroduce MOCK_MODULES_MAPPING
Some mocks needs some attributes defined (instead of having them returning a
mock object). Introduce a MOCK_MODULES_MAPPING mapping that defines these
attributes. This gets rid of a special handling for psutil.

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:37 +01:00
Benjamin Drung
cf648246ea doc: Move mock_decorator_with_params up
Refactor conf.py and move mock_decorator_with_params for the following commit.

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:37 +01:00
Benjamin Drung
08ef6694ea doc: Address pylint issues in conf.py
pylint finds issues in doc/conf.py:

```
pylint3 conf.py
************* Module conf
conf.py:226:0: C0330: Wrong hanging indentation (remove 4 spaces).
        os.pardir,  # salt itself (for autodoc)
    |   ^ (bad-continuation)
conf.py:227:0: C0330: Wrong hanging indentation (remove 4 spaces).
        '_ext',  # custom Sphinx extensions
    |   ^ (bad-continuation)
conf.py:374:0: C0301: Line too long (106/100) (line-too-long)
conf.py:442:0: C0330: Wrong hanging indentation (add 2 spaces).
  ('contents', 'Salt.tex', 'Salt Documentation', 'SaltStack, Inc.', 'manual'),
  ^ | (bad-continuation)
conf.py:485:0: C0301: Line too long (107/100) (line-too-long)
conf.py:27:0: W0613: Unused argument 'args' (unused-argument)
conf.py:27:0: W0613: Unused argument 'kwargs' (unused-argument)
conf.py:58:4: R0201: Method could be a function (no-self-use)
conf.py:198:8: R1705: Unnecessary "else" after "return" (no-else-return)
conf.py:197:0: W0613: Unused argument 'iargs' (unused-argument)
conf.py:197:0: W0613: Unused argument 'ikwargs' (unused-argument)
conf.py:187:0: W0613: Unused argument 'oargs' (unused-argument)
conf.py:187:0: W0613: Unused argument 'okwargs' (unused-argument)
conf.py:533:0: R0913: Too many arguments (6/5) (too-many-arguments)
conf.py:533:25: W0613: Unused argument 'app' (unused-argument)
conf.py:533:30: W0613: Unused argument 'what' (unused-argument)
conf.py:533:47: W0613: Unused argument 'skip' (unused-argument)
conf.py:533:53: W0613: Unused argument 'options' (unused-argument)
conf.py:542:7: W0621: Redefining name 'path' from outer scope (line 230) (redefined-outer-name)
conf.py:6:0: W0611: Unused import functools (unused-import)
conf.py:310:4: W0611: Unused import sphinxcontrib.spelling (unused-import)
```

Address those or silince pylint for wanted behavior.

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:35 +01:00
Benjamin Drung
67a3e371a6 doc: Mark preamble variable as raw string
Importing `doc/conf.py` fails with Python 3.7:

```
>>> from conf import Mock
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "doc/conf.py", line 454
    ''',
SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 5-6: truncated \uXXXX escape
```

Therefore mark the string as raw due to the backslashes.

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:03 +01:00
Benjamin Drung
b1e6080329 doc: Fix reference to salt executors
sphinx shows a warning:

doc/topics/development/modules/index.rst:133: WARNING: undefined label:
all-salt_executors (if the link has no caption the label must precede a section
header)

The executors reference is called all-salt.executors (with a dot instead of an
underscore).

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:03 +01:00
Benjamin Drung
e48b3247c2 doc: Replace \xa0 (non-breaking space) by spaces
Creating the documentation produces a warning:

```
doc/topics/targeting/index.rst:90: WARNING: Could not lex literal_block as "yaml". Highlighting skipped.
```

Therefore replace the non-breaking spaces \xa0 by normal spaces.

Signed-off-by: Benjamin Drung <benjamin.drung@cloud.ionos.com>
2018-12-19 13:55:03 +01:00