Salt's documentation is built using the Sphinx documentation system. It can be built in a large variety of output formats including HTML, PDF, ePub, and manpage.
All the documentation is contained in the main Salt repository. Speaking broadly, most of the narrative documentation is contained within the https://github.com/saltstack/salt/blob/develop/doc subdirectory and most of the reference and API documentation is written inline with Salt's Python code and extracted using a Sphinx extension.
The Salt project recommends the IEEE style guide as a general reference for writing guidelines. Those guidelines are not strictly enforced but rather serve as an excellent resource for technical writing questions. The NCBI style guide is another very approachable resource.
Use third-person perspective and avoid "I", "we", "you" forms of address. Identify the addressee specifically e.g., "users should", "the compiler does", etc.
Use active voice and present-tense. Avoid filler words.
Document titles and section titles within a page should follow normal sentence capitalization rules. Words that are capitalized as part of a regular sentence should be capitalized in a title and otherwise left as lowercase. Punctuation can be omitted unless it aids the intent of the title (e.g., exclamation points or question marks).
This is a main heading ====================== Paragraph. This is an exciting sub-heading! -------------------------------- Paragraph.
According to Wikipedia: In English punctuation, a serial comma or series comma (also called Oxford comma and Harvard comma) is a comma placed immediately before the coordinating conjunction (usually "and", "or", or "nor") in a series of three or more terms. For example, a list of three countries might be punctuated either as "France, Italy, and Spain" (with the serial comma), or as "France, Italy and Spain" (without the serial comma)."
When writing a list that includes three or more items, the serial comma should always be used.
Documentation for Salt's various module types is inline in the code. During the documentation build process it is extracted and formatted into the final HTML, PDF, etc format.
Python has special multi-line strings called docstrings as the first element in a function or class. These strings allow documentation to live alongside the code and can contain special formatting. For example:
def my_function(value): ''' Upper-case the given value Usage: .. code-block:: python val = 'a string' new_val = myfunction(val) print(new_val) # 'A STRING' :param value: a string :return: a copy of ``value`` that has been upper-cased ''' return value.upper()
New functions or changes to existing functions should include a marker that denotes what Salt release will be affected. For example:
def my_function(value): ''' Upper-case the given value .. versionadded:: 2014.7.0 <...snip...> ''' return value.upper()
For changes to a function:
def my_function(value, strip=False): ''' Upper-case the given value .. versionchanged:: 2016.3.0 Added a flag to also strip whitespace from the string. <...snip...> ''' if strip: return value.upper().strip() return value.upper()
.rstfile for the new module in the same directory as the
index.rstand the new
.rstfile and send a pull request.
The Sphinx documentation system contains a wide variety of cross-referencing capabilities.
A common way to encapsulate master-side functionality is by writing a custom :term:`Runner Function`. Custom Runner Functions are easy to write.
Sphinx automatically generates many kinds of index entries, but it is occasionally useful to manually add items to the index.
One method is to use the index directive above the document or section that should appear in the index.
.. index:: ! Event, event bus, event system see: Reactor; Event
Another method is to use the index role inline with the text that should appear in the index. The index entry is created and the target text is left otherwise intact.
Information about the :index:`Salt Reactor` ------------------------------------------- Paragraph.
Each document should contain a unique top-level label of the form:
.. _my-page: My page ======= Paragraph.
Unique labels can be linked using the ref role. This allows cross-references to survive document renames or movement.
For more information see :ref:`my-page`.
:doc: role should not be used to link documents together.
Cross-references to Salt modules can be added using Sphinx's Python domain
roles. For example, to create a link to the
A useful execution module to test active communication with a minion is the :py:func:`test.ping <salt.modules.test.ping>` function.
Salt modules can be referenced as well:
The :py:mod:`test module <salt.modules.test>` contains many useful functions for inspecting an active Salt connection.
The same syntax works for all modules types:
One of the workhorse state module functions in Salt is the :py:func:`file.managed <salt.states.file.managed>` function.
Individual settings in the Salt Master or Salt Minion configuration files are
cross-referenced using two custom roles,
The :conf_minion:`minion ID <id>` setting is a unique identifier for a single minion.
Documentation changes and fixes should be made against the earliest supported
release branch that the update applies to. The practice of updating a release
branch instead of making all documentation changes against Salt's main, default
develop, is necessary in order for the docs to be as up-to-date as
possible when the docs are built.
The workflow mentioned above is also in line with the recommendations outlined in Salt's Contributing page. You can read more about how to choose where to submit documentation fixes by reading the Salt's Branch Topology section.
For an explanation of how to submit changes against various branches, see the
Sending a GitHub pull request section. Specifically, see the section describing
Create a new branch and the steps that follow.
Install Sphinx using a system package manager or pip. The package name is
often of the form
python-sphinx. There are no other dependencies.
Build the documentation using the provided Makefile or
.bat file on
cd /path/to/salt/doc make html
The generated documentation will be written to the
A useful method of viewing the HTML documentation locally is to start Python's built-in HTTP server:
cd /path/to/salt/doc/_build/html python -m SimpleHTTPServer
Then pull up the documentation in a web browser at http://localhost:8000/.