@@ -236,6 +236,18 @@ \section{Special Markup Constructs}
236236 macros. This section contains the reference material for these
237237 facilities.
238238
239+ \subsection {Markup for the Preamble \label {preamble-info } }
240+
241+ \begin {macrodesc }{release}{\p {ver}}
242+ Set the version number for the software described in the
243+ document.
244+ \end {macrodesc }
245+
246+ \begin {macrodesc }{setshortversion}{\p {sver}}
247+ Specify the `` short'' version number of the documented software
248+ to be \var {sver}.
249+ \end {macrodesc }
250+
239251 \subsection {Meta-information Markup \label {meta-info } }
240252
241253 \begin {macrodesc }{sectionauthor}{\p {author}\p {email}}
@@ -567,6 +579,17 @@ \section{Special Markup Constructs}
567579 acceptable.
568580 \end {macrodesc }
569581
582+ \begin {macrodesc }{shortversion}{}
583+ The `` short'' version number of the documented software, as
584+ specified using the \macro {setshortversion} macro in the
585+ preamble. For Python, the short version number for a release is
586+ the first three characters of the \code {sys.version} value. For
587+ example, versions 2.0b1 and 2.0.1 both have a short version of
588+ 2.0. This may not apply for all packages; if
589+ \macro {setshortversion} is not used, this produces an empty
590+ expansion. See also the \macro {version} macro.
591+ \end {macrodesc }
592+
570593 \begin {macrodesc }{strong}{\p {text}}
571594 Strongly emphasized text; this will be presented using a bold
572595 font.
@@ -588,8 +611,9 @@ \section{Special Markup Constructs}
588611 \end {macrodesc }
589612
590613 \begin {macrodesc }{version}{}
591- The version number for the documentation, as specified using
592- \macro {release} in the preamble.
614+ The version number of the described software, as specified using
615+ \macro {release} in the preamble. See also the
616+ \macro {shortversion} macro.
593617 \end {macrodesc }
594618
595619 \begin {macrodesc }{versionadded}{\p {version}}
0 commit comments