From 92d3eeecf9374e0a09e8a429deae7802e958c21a Mon Sep 17 00:00:00 2001 From: endolith Date: Mon, 18 Nov 2024 14:10:28 -0500 Subject: [PATCH] Fix doi links --- docs/conf.py | 19 ++++++++++++++++++- docs/requirements.txt | 3 ++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6475a6d..3257ecb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,8 @@ 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'sphinxcontrib.mermaid', - 'myst_parser' + 'myst_parser', + 'sphinx.ext.extlinks' ] extlinks = { @@ -92,5 +93,21 @@ def setup(app): # Add this to enable regular markdown mermaid syntax myst_fence_as_directive = ["mermaid"] +# MyST configuration +myst_enable_extensions = [ + "colon_fence", # For ::: fences + "dollarmath", # For $$ + "linkify", # Auto-convert bare URLs to links + "substitution", # For {{ var }} + "tasklist", # For [ ] task lists +] + +# Enable MyST to parse reST directives in markdown +myst_all_links_external = True +myst_heading_anchors = 3 +myst_footnote_transition = True +myst_dmath_double_inline = True +myst_enable_checkboxes = True + # Add README.md as the index page root_doc = 'index' # or 'contents' in older versions diff --git a/docs/requirements.txt b/docs/requirements.txt index f272c49..ba6e767 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,4 +3,5 @@ sphinxcontrib.mermaid -e . numpydoc sphinx_rtd_theme -sphinxcontrib-apidoc \ No newline at end of file +sphinxcontrib-apidoc +linkify-it-py \ No newline at end of file