changeset 5780:e117cf7401db

doc: switch rst `=` section underlines to `-` When using GENDOC_LOAD_CONFIGURED_EXTENSIONS=1, Mercurial's doc/gendoc.py can load extensions from outside of just the hgext directory, and pull in this doc. When added to the documentation, this should be nested inside of the following extension hierarchy: - Extensions - evolve The generated documentation has an established hierarchy of section headers, and the above uses `"` for top level, and `=` for each extension. Since gendoc just pastes it in verbatim, with `=` underlines, we get "Obsolescence Markers Discovery", "Effect Flag Experiment", and "Template keywords" as siblings to the evolve extension, instead of nested inside of it. This is not required for the string below it (that shows up with `hg help evolution`), as that is one level higher in the hierarchy (not nested inside of an "Extensions" section), so `=` is appropriate there.
author Kyle Lippincott <spectral@google.com>
date Wed, 17 Feb 2021 14:00:43 -0800
parents 96ed73c5c6ca
children 613a144de642
files hgext3rd/evolve/__init__.py
diffstat 1 files changed, 3 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/hgext3rd/evolve/__init__.py	Wed Feb 17 12:00:45 2021 -0800
+++ b/hgext3rd/evolve/__init__.py	Wed Feb 17 14:00:43 2021 -0800
@@ -52,7 +52,7 @@
     evolution.obsdiscovery = yes
 
 Obsolescence Markers Discovery
-==============================
+------------------------------
 
 The evolve extension containts an experimental new protocol to discover common
 markers between local and remote repositories.
@@ -111,7 +111,7 @@
     evolution.obsdiscovery = no
 
 Effect Flag Experiment
-======================
+----------------------
 
 Evolve also records what changed between two evolutions of a changeset. For
 example, having this information is helpful to understand what changed between
@@ -154,7 +154,7 @@
 the effect flag recording.
 
 Template keywords
-=================
+-----------------
 
 Evolve provides one template keyword that helps explore obsolescence history: