set myst_heading_anchor for doc

RunningLeon · May 18, 2022 · 9baecee · 9baecee
1 parent 673bbba
commit 9baecee
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -80,7 +80,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -104,8 +104,7 @@
 # documentation.
 #
 html_theme_options = {
-    # TODO: Add log_url
-    # 'logo_url': 'https://mmocr.readthedocs.io/en/latest/',
+    'logo_url': 'https://mmdeploy.readthedocs.io/en/latest/',
     'menu': [{
         'name': 'GitHub',
         'url': 'https://github.com/open-mmlab/mmdeploy'
@@ -119,6 +118,10 @@
 html_static_path = ['_static']
 html_css_files = ['css/readthedocs.css']
 
+# Enable ::: for my_st
+myst_enable_extensions = ['colon_fence']
+myst_heading_anchors = 5
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #

diff --git a/docs/zh_cn/conf.py b/docs/zh_cn/conf.py
@@ -118,6 +118,10 @@
 html_static_path = ['_static']
 html_css_files = ['css/readthedocs.css']
 
+# Enable ::: for my_st
+myst_enable_extensions = ['colon_fence']
+myst_heading_anchors = 5
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #