doctests: add dochtml label to some tests that need docs installed

sagemath · Dec 26, 2021 · 42a76c3 · 42a76c3
1 parent 7d3381b
commit 42a76c3
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/sage_docbuild/__init__.py b/src/sage_docbuild/__init__.py
@@ -105,7 +105,7 @@ def builder_helper(type):
         sage: from sage_docbuild import builder_helper, build_ref_doc
         sage: from sage_docbuild import _build_many as build_many
         sage: helper = builder_helper("html")
-        sage: try:
+        sage: try:  # optional - dochtml
         ....:     build_many(build_ref_doc, [("docname", "en", "html", {})])
         ....: except Exception as E:
         ....:     "Non-exception during docbuild: abort pool operation" in str(E)
@@ -186,7 +186,7 @@ def _output_dir(self, type):
 
             sage: from sage_docbuild import DocBuilder
             sage: b = DocBuilder('tutorial')
-            sage: b._output_dir('html')
+            sage: b._output_dir('html')         # optional - dochtml
             '.../html/en/tutorial'
         """
         d = os.path.join(SAGE_DOC, type, self.lang, self.name)
@@ -203,7 +203,7 @@ def _doctrees_dir(self):
 
             sage: from sage_docbuild import DocBuilder
             sage: b = DocBuilder('tutorial')
-            sage: b._doctrees_dir()
+            sage: b._doctrees_dir()             # optional - docthml
             '.../doctrees/en/tutorial'
         """
         d = os.path.join(SAGE_DOC, 'doctrees', self.lang, self.name)
@@ -529,7 +529,7 @@ def _output_dir(self, type, lang=None):
 
             sage: from sage_docbuild import ReferenceBuilder
             sage: b = ReferenceBuilder('reference')
-            sage: b._output_dir('html')
+            sage: b._output_dir('html')         # optional - dochtml
             '.../html/en/reference'
         """
         if lang is None:
@@ -640,7 +640,7 @@ def _output_dir(self, type, lang=None):
 
             sage: from sage_docbuild import ReferenceTopBuilder
             sage: b = ReferenceTopBuilder('reference')
-            sage: b._output_dir('html')
+            sage: b._output_dir('html')         # optional - dochtml
             '.../html/en/reference'
         """
         if lang is None: