Merge branch 'patch-sphinx-3.5.3'

.readthedocs.yaml

@@ -0,0 +1,19 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats: [htmlzip, pdf]
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:
+   - requirements: requirements.txt

Pipfile

@@ -4,6 +4,6 @@ verify_ssl = true
 
 [packages]
 sphinx-autobuild = "*"
-docutils = "==0.13.1"
-Sphinx = "==1.8.4"
-sphinx_rtd_theme = "==0.4.3"
+docutils = "==0.16"
+Sphinx = "==3.5.3"
+sphinx_rtd_theme = "==0.5.1"

docs/_extensions/tecs.py

@@ -16,7 +16,7 @@
 from sphinx.roles import XRefRole
 from sphinx.domains import Domain, ObjType
 from sphinx.directives import ObjectDescription
-from sphinx.locale import l_, _
+from sphinx.locale import _
 from sphinx.util.nodes import make_refnode
 from sphinx.util.docfields import Field, TypedField
 
@@ -68,8 +68,14 @@ class TECSObject(ObjectDescription):
     """Description of a TECS object.
     """
 
-    # stopwords imported from C
-    stopwords = CObject.stopwords
+    # stopwords copied from those of C
+    # (https://github.com/sphinx-doc/sphinx/blob/2f61ba8/sphinx/domains/c.py#L76)
+    stopwords = set((
+        'const', 'void', 'char', 'wchar_t', 'int', 'short',
+        'long', 'float', 'double', 'unsigned', 'signed', 'FILE',
+        'clock_t', 'time_t', 'ptrdiff_t', 'size_t', 'ssize_t',
+        'struct', '_Bool',
+    ))
 
     def get_index_text(self, name):
         raise NotImplementedError("must be implemented in subclass")
@@ -365,15 +371,15 @@ class TECSDomain(Domain):
     name = 'tecs'
     label = 'TECS'
     object_types = {
-        'celltype':     ObjType(l_('cell type'),    'celltype'),
-        'cell':         ObjType(l_('cell'),         'cell'),
-        'call':         ObjType(l_('call port'),    'call'),
-        'entry':        ObjType(l_('entry port'),   'entry'),
-        'attribute':    ObjType(l_('attribute'),    'attr'),
-        'variable':     ObjType(l_('variable'),     'var'),
-        'signature':    ObjType(l_('signature'),    'signature'),
-        'sigfunction':  ObjType(l_('sigfunction'),  'sigfunction'),
-        'namespace':    ObjType(l_('namespace'),    'namespace'),
+        'celltype':     ObjType(_('cell type'),    'celltype'),
+        'cell':         ObjType(_('cell'),         'cell'),
+        'call':         ObjType(_('call port'),    'call'),
+        'entry':        ObjType(_('entry port'),   'entry'),
+        'attribute':    ObjType(_('attribute'),    'attr'),
+        'variable':     ObjType(_('variable'),     'var'),
+        'signature':    ObjType(_('signature'),    'signature'),
+        'sigfunction':  ObjType(_('sigfunction'),  'sigfunction'),
+        'namespace':    ObjType(_('namespace'),    'namespace'),
     }
     directives = {
         'celltype':     TECSCellTypeObject,

docs/conf.py

@@ -126,6 +126,9 @@
     'toppers3-tag': ('https://www.toppers.jp/documents.html#tgki_spec.%s', '')
 }
 
+# Disable converting quotes to CJK brackets.
+smartquotes = False
+
 # -- Options for HTML output ----------------------------------------------
 
 import sphinx_rtd_theme
@@ -180,11 +183,6 @@
 #
 # html_last_updated_fmt = None
 
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#
-# html_use_smartypants = True
-
 # Custom sidebar templates, maps document names to template names.
 #
 # html_sidebars = {}
@@ -300,12 +298,6 @@
 #
 # latex_appendices = []
 
-# It false, will not define \strong, \code, 	itleref, \crossref ... but only
-# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
-# packages.
-#
-# latex_keep_old_macro_names = True
-
 # If false, no module index is generated.
 #
 # latex_domain_indices = True

requirements.txt

@@ -1,5 +1,5 @@
-Sphinx==1.8.4
-sphinx-autobuild==0.5.2
-sphinx-rtd-theme==0.4.3
-docutils==0.13.1
+Sphinx==3.5.3
+sphinx-autobuild==2021.3.14
+sphinx-rtd-theme==0.5.1
+docutils==0.16