Skip Menu |
 

From: kaduk@MIT.EDU
Subject: SVN Commit
Download (untitled) / with headers
text/plain 1.8KiB

Reformat RST to avoid sphinx warnings

Old versions of docutils will see inline markup (e.g., :ref:`foo`)
at the beginning of a line in the content of a directive block
and attempt to interpret that markup as options or arguments
to the directive. RST intended as inline markup (as opposed to
modifying the behavior of the directive) will not be interpretable
in this context, and causes Sphinx to emit a warning.

Work around this behavior by always leaving a blank line before
the content of a directive block, forcing it to be interpreted
as content and not options or arguments.

The buggy behavior was only encountered in note environments, but
for consistency of style, also reformat warning and error blocks.

Note the new style constraint in doc/README.

https://github.com/krb5/krb5/commit/8bff1e50c28b6f11b771add7bd7d4a57419a567b
Author: Ben Kaduk <kaduk@mit.edu>
Commit: 8bff1e50c28b6f11b771add7bd7d4a57419a567b
Branch: master
doc/README | 4 +++
doc/admin/admin_commands/kadmin_local.rst | 1 +
doc/admin/admin_commands/krb5kdc.rst | 4 ++-
doc/admin/conf_files/kadm5_acl.rst | 5 +++-
doc/admin/conf_files/kdc_conf.rst | 4 ++-
doc/admin/conf_files/krb5_conf.rst | 4 ++-
doc/admin/database.rst | 32 +++++++++++++++++-----
doc/admin/install_kdc.rst | 41 ++++++++++++++++++++++-------
doc/admin/troubleshoot.rst | 8 ++++-
doc/appdev/gssapi.rst | 12 ++++++--
doc/basic/date_format.rst | 2 +
doc/basic/stash_file_def.rst | 4 ++-
doc/plugindev/profile.rst | 4 ++-
doc/tools/func_document.tmpl | 3 ++
doc/user/tkt_mgmt.rst | 4 ++-
doc/user/user_commands/ksu.rst | 8 ++++-
16 files changed, 108 insertions(+), 32 deletions(-)
From: tlyu@mit.edu
Subject: SVN Commit
Download (untitled) / with headers
text/plain 1.9KiB

Reformat RST to avoid sphinx warnings

Old versions of docutils will see inline markup (e.g., :ref:`foo`)
at the beginning of a line in the content of a directive block
and attempt to interpret that markup as options or arguments
to the directive. RST intended as inline markup (as opposed to
modifying the behavior of the directive) will not be interpretable
in this context, and causes Sphinx to emit a warning.

Work around this behavior by always leaving a blank line before
the content of a directive block, forcing it to be interpreted
as content and not options or arguments.

The buggy behavior was only encountered in note environments, but
for consistency of style, also reformat warning and error blocks.

Note the new style constraint in doc/README.

(cherry picked from commit 8bff1e50c28b6f11b771add7bd7d4a57419a567b)

https://github.com/krb5/krb5/commit/58f208793d5447df458b03e76f5a4037f9908c83
Author: Ben Kaduk <kaduk@mit.edu>
Committer: Tom Yu <tlyu@mit.edu>
Commit: 58f208793d5447df458b03e76f5a4037f9908c83
Branch: krb5-1.11
doc/README | 4 +++
doc/admin/admin_commands/kadmin_local.rst | 1 +
doc/admin/admin_commands/krb5kdc.rst | 4 ++-
doc/admin/conf_files/kadm5_acl.rst | 5 +++-
doc/admin/conf_files/kdc_conf.rst | 4 ++-
doc/admin/conf_files/krb5_conf.rst | 4 ++-
doc/admin/database.rst | 32 +++++++++++++++++-----
doc/admin/install_kdc.rst | 41 ++++++++++++++++++++++-------
doc/admin/troubleshoot.rst | 8 ++++-
doc/appdev/gssapi.rst | 12 ++++++--
doc/basic/date_format.rst | 2 +
doc/basic/stash_file_def.rst | 4 ++-
doc/plugindev/profile.rst | 4 ++-
doc/tools/func_document.tmpl | 3 ++
doc/user/tkt_mgmt.rst | 4 ++-
doc/user/user_commands/ksu.rst | 8 ++++-
16 files changed, 108 insertions(+), 32 deletions(-)