You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi, i'm building docs using .rst files as source files. Now i want my README.md file to be shown as the first page on the docs so i'm using myst_parser to parse that md file into sphinx.
The problem is that in the build, hyperlinks and code blocks are broken.
This is the part regarding myst configuration in my conf.py
importsysfromdisnake.extimportcomponentssys.modules["components"] =componentsproject=components.__name__copyright=components.__copyright__author=components.__author__version=components.__version__release=version# consider to use autosummary# consider to use MyST to generates docs directly from .md files# this will for example allow us to make the welcome page of our docs# exactly the same as the README.md of the github repoextensions= [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx.ext.extlinks",
"sphinx.ext.viewcode",
# third party extensions"sphinx_copybutton",
"sphinx_inline_tabs",
"myst_parser"
]
templates_path= ["_templates"]
exclude_patterns= ["_build"]
source_suffix= {
".rst": "restructuredtext",
'.md': 'markdown',
}
source_parsers= {
".md": "myst_parser.parsers.sphinx_.MystParser"
}
master_doc="index"# -- MySt settings --myst_all_links_external=Truemyst_heading_anchors=3
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi, i'm building docs using
.rst
files as source files. Now i want my README.md file to be shown as the first page on the docs so i'm using myst_parser to parse that md file into sphinx.The problem is that in the build, hyperlinks and code blocks are broken.
This is the part regarding myst configuration in my conf.py
Beta Was this translation helpful? Give feedback.
All reactions