Skip to content

Commit

Permalink
Fix doi links
Browse files Browse the repository at this point in the history
  • Loading branch information
endolith committed Nov 18, 2024
1 parent cc25478 commit 92d3eee
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
19 changes: 18 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinxcontrib.mermaid',
'myst_parser'
'myst_parser',
'sphinx.ext.extlinks'
]

extlinks = {
Expand Down Expand Up @@ -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
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ sphinxcontrib.mermaid
-e .
numpydoc
sphinx_rtd_theme
sphinxcontrib-apidoc
sphinxcontrib-apidoc
linkify-it-py

0 comments on commit 92d3eee

Please sign in to comment.