doc: migrate link-roles.py to sphinx.ext.extlinks

yanbe · Sep 20, 2017 · 4a26be1 · 4a26be1
1 parent cf8d887
commit 4a26be1
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 43 deletions.
diff --git a/docs/api-reference/pcd8544/index.rst b/docs/api-reference/pcd8544/index.rst
@@ -9,8 +9,8 @@ ESP32-PCD8544 is dedicated driver implementation of PCD8544 LCD controller (a.k.
 Application Examples
 --------------------
 
-* "Hello world" example - `hello_pcd8544 <https://github.com/yanbe/esp32-pcd8544-examples/tree/master/examples/hello_pcd8544>`_
-* Draw lines via frame buffer - `draw_lines <https://github.com/yanbe/esp32-pcd8544-examples/tree/master/examples/draw_lines>`_
+* "Hello world" example - :example:`hello_pcd8544`
+* Draw lines via frame buffer - :example:`draw_lines`
 
 ( more example projects will be written here )
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -20,8 +20,7 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-import sys
-import os
+import sys, os
 
 from subprocess import call
 
@@ -44,9 +43,16 @@
 breathe_projects = { "esp32-pcd8544": "xml/" }
 breathe_default_project = "esp32-pcd8544"
 
+extensions += ['sphinx.ext.extlinks']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+extlinks = {
+    'example': ('https://github.com/yanbe/esp32-pcd8544-examples/tree/master/examples/%s', ''),
+    'component_file': ('https://github.com/yanbe/esp32-pcd8544/tree/master/%s', '')
+}
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #

diff --git a/docs/link-roles.py b/docs/link-roles.py
diff --git a/docs/repo_util.py b/docs/repo_util.py