Commit graph

9135 commits

Author SHA1 Message Date
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
Benjamin Drung
b973e7aae1 doc: Fix iterating over the Mock object in Python 3
Building the documentation for salt.modules.snapper fails with Python 3:

```
$ make -C doc html
[...]
WARNING: [autosummary] failed to import 'salt.modules.snapper': no module named salt.modules.snapper
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 109 source files that are out of date
updating environment: [config changed] 1608 added, 17 changed, 0 removed
reading sources... [100%] topics/yaml/index
doc/ref/modules/all/index.rst:20: WARNING: failed to import snapper
doc/ref/modules/all/index.rst:20: WARNING: toctree references unknown document 'ref/modules/all/snapper'
WARNING: autodoc: failed to import module 'salt.modules.snapper'; the following exception was raised:
Traceback (most recent call last):
  File "/usr/lib/python3/dist-packages/sphinx/ext/autodoc/importer.py", line 152, in import_module
    __import__(modname)
  File "salt/modules/snapper.py", line 72, in <module>
    if SNAPPER_DBUS_OBJECT in bus.list_activatable_names():
TypeError: argument of type 'Mock' is not iterable
```

Fix the Mock object to be iterable (as it was intended to).

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