Remove doctitle if not using reST docinfo metadata

Fix #2382, Fix #3124. Signed-off-by: Chris Warrick <kwpolska@gmail.com>
getnikola · Sep 6, 2018 · c2b275a · c2b275a
1 parent 49042eb
commit c2b275a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -21,6 +21,8 @@ Features
 Bugfixes
 --------
 
+* Do not remove first heading in document (reST document title)
+  if ``USE_REST_DOCINFO_METADATA`` is disabled (Issue #3124)
 * Remove ``NO_DOCUTILS_TITLE_TRANSFORM`` setting,
   this is now default behavior if ``USE_REST_DOCINFO_METADATA``
   is disabled (Issue #2382, #3124)

diff --git a/nikola/conf.py.in b/nikola/conf.py.in
@@ -1139,7 +1139,9 @@ MARKDOWN_EXTENSIONS = ['markdown.extensions.fenced_code', 'markdown.extensions.c
 # Should titles fetched from file metadata be unslugified (made prettier?)
 # FILE_METADATA_UNSLUGIFY_TITLES = True
 
-# If enabled, extract metadata from docinfo fields in reST documents
+# If enabled, extract metadata from docinfo fields in reST documents.
+# If your text files start with a level 1 heading, it will be treated as the
+# document title and will be removed from the text.
 # USE_REST_DOCINFO_METADATA = False
 
 # If enabled, hide docinfo fields in reST document output

diff --git a/nikola/plugins/compile/rest/__init__.py b/nikola/plugins/compile/rest/__init__.py
@@ -124,7 +124,8 @@ def compile_string(self, data, source_path=None, is_two_file=True, post=None, la
             # warnings about it from reST.
             'math_output': 'mathjax /assets/js/mathjax.js',
             'template': default_template_path,
-            'language_code': LEGAL_VALUES['DOCUTILS_LOCALES'].get(LocaleBorg().current_lang, 'en')
+            'language_code': LEGAL_VALUES['DOCUTILS_LOCALES'].get(LocaleBorg().current_lang, 'en'),
+            'doctitle_xform': not self.site.config.get('USE_REST_DOCINFO_METADATA'),
         }
 
         from nikola import shortcodes as sc