aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorshirt-dev <2660574+shirt-dev@users.noreply.github.com>2021-02-25 10:46:08 -0500
committerGitHub <noreply@github.com>2021-02-25 21:16:08 +0530
commitb965087396ddb2d40dfe5bc12391ee000945129d (patch)
tree4cac8e4d9f37debcf032c4028f6c11b032e28a97 /docs/conf.py
parent0e0040519bf5554dabfcb1a3be106d94f18379cc (diff)
downloadhypervideo-pre-b965087396ddb2d40dfe5bc12391ee000945129d.tar.lz
hypervideo-pre-b965087396ddb2d40dfe5bc12391ee000945129d.tar.xz
hypervideo-pre-b965087396ddb2d40dfe5bc12391ee000945129d.zip
Readthedocs improvements (#115)
Authored-by: shirtjs <2660574+shirtjs@users.noreply.github.com> :ci skip dl
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py23
1 files changed, 8 insertions, 15 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 3fbf82f54..c4010bbc7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,26 +7,21 @@ import os
# Allows to import yt-dlp
sys.path.insert(0, os.path.abspath('..'))
-from recommonmark.transform import AutoStructify
# -- General configuration ------------------------------------------------
-# The suffix of source filenames.
-source_suffix = ['.rst', '.md']
-
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'sphinx.ext.autodoc',
- 'recommonmark',
+ 'myst_parser',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The master toctree document.
-master_doc = 'index'
+master_doc = 'README'
# General information about the project.
project = u'yt-dlp'
@@ -64,12 +59,10 @@ highlight_language = 'none'
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
+# Enable heading anchors
+myst_heading_anchors = 4
-def setup(app):
- app.add_config_value('recommonmark_config', {
- 'enable_math': False,
- 'enable_inline_math': False,
- 'enable_eval_rst': True,
- 'enable_auto_toc_tree': True,
- }, True)
- app.add_transform(AutoStructify)
+# Suppress heading warnings
+suppress_warnings = [
+ 'myst.header',
+]