diff --git a/docs/conf.py b/docs/conf.py index 9f92f64969d0..183f5176c638 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,9 +6,6 @@ from __future__ import absolute_import, unicode_literals import os import sys -import warnings - -from recommonmark.transform import AutoStructify # Set up Python environment to load build system packages. OUR_DIR = os.path.dirname(__file__) @@ -35,6 +32,7 @@ sys.path[:0] = [os.path.join(topsrcdir, p) for p in EXTRA_PATHS] sys.path.insert(0, OUR_DIR) extensions = [ + "myst_parser", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx.ext.doctest", @@ -44,7 +42,6 @@ extensions = [ "mozbuild.sphinx", "sphinx_js", "sphinxcontrib.mermaid", - "recommonmark", "sphinx_copybutton", "sphinx_markdown_tables", "sphinx_panels", @@ -121,25 +118,5 @@ def install_sphinx_panels(app, pagename, templatename, context, doctree): def setup(app): - app.add_config_value( - "recommonmark_config", - { - # Crashes with sphinx - "enable_inline_math": False, - # We use it for testing/web-platform/tests - "enable_eval_rst": True, - }, - True, - ) - - # Silent a warning - # https://github.com/readthedocs/recommonmark/issues/177 - warnings.filterwarnings( - action="ignore", - category=UserWarning, - message=r".*Container node skipped.*", - ) - app.add_css_file("custom_theme.css") - app.add_transform(AutoStructify) app.connect("html-page-context", install_sphinx_panels) diff --git a/tools/moztreedocs/requirements.in b/tools/moztreedocs/requirements.in index 16f70da0811b..81ef29a803aa 100644 --- a/tools/moztreedocs/requirements.in +++ b/tools/moztreedocs/requirements.in @@ -22,6 +22,8 @@ livereload==2.6.3 Markdown==3.3.4 MarkupSafe==1.1.1 mock==4.0.2 +myst-parser==0.16.1 +mdit-py-plugins==0.3.0 packaging==20.4 parsimonious==0.7.0 pyasn1==0.4.8 @@ -32,7 +34,6 @@ python-dateutil==2.8.2 python-frontmatter==0.5.0 pytz==2020.1 PyYAML==5.3.1 -recommonmark==0.7.1 redo==2.0.3 requests==2.24.0 rsa==4.6 diff --git a/tools/moztreedocs/requirements.txt b/tools/moztreedocs/requirements.txt index 3c104b15e272..f11615cb3f9a 100644 --- a/tools/moztreedocs/requirements.txt +++ b/tools/moztreedocs/requirements.txt @@ -13,7 +13,9 @@ alabaster==0.7.12 \ attrs==21.2.0 \ --hash=sha256:149e90d6d8ac20db7a955ad60cf0e6881a3f20d37096140088356da6c716b0b1 \ --hash=sha256:ef6aaac3ca6cd92904cdd0d83f629a15f18053ec84e6432106f7a4d04ae4f5fb - # via jsonschema + # via + # jsonschema + # markdown-it-py babel==2.8.0 \ --hash=sha256:1aac2ae2d0d8ea368fa90906567f5c08463d98ade155c0c4bfedd6a0f7160e38 \ --hash=sha256:d670ea0b10f8b723672d3a6abeb87b565b244da220d76b4dba1b66269ec152d4 @@ -55,15 +57,13 @@ colorama==0.4.4 \ commonmark==0.9.1 \ --hash=sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60 \ --hash=sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9 - # via - # -r requirements.in - # recommonmark + # via -r requirements.in docutils==0.16 \ --hash=sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af \ --hash=sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc # via # -r requirements.in - # recommonmark + # myst-parser # sphinx # sphinx-js # sphinx-panels @@ -103,6 +103,7 @@ jinja2==2.11.2 \ --hash=sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035 # via # -r requirements.in + # myst-parser # sphinx # sphinx-js jmespath==0.10.0 \ @@ -119,9 +120,18 @@ jsonschema==3.2.0 \ livereload==2.6.3 \ --hash=sha256:776f2f865e59fde56490a56bcc6773b6917366bce0c267c60ee8aaf1a0959869 # via -r requirements.in -Markdown==3.3.4 \ +markdown==3.3.4 \ --hash=sha256:31b5b491868dcc87d6c24b7e3d19a0d730d59d3e46f4eea6430a321bed387a49 \ --hash=sha256:96c3ba1261de2f7547b46a00ea8463832c921d3f9d6aba3f255a6f71386db20c + # via + # -r requirements.in + # sphinx-markdown-tables +markdown-it-py==2.0.0 \ + --hash=sha256:15cc69c5b7c493ba8603722b710e39ce3fab2961994179fb4fa1c99b070d2059 \ + --hash=sha256:c138a596f6c9988e0b5fa3299bc38ffa76c75076bc178e8dfac40a84343c7022 + # via + # mdit-py-plugins + # myst-parser markupsafe==1.1.1 \ --hash=sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473 \ --hash=sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161 \ @@ -178,10 +188,24 @@ markupsafe==1.1.1 \ # via # -r requirements.in # jinja2 +mdit-py-plugins==0.3.0 \ + --hash=sha256:b1279701cee2dbf50e188d3da5f51fee8d78d038cdf99be57c6b9d1aa93b4073 \ + --hash=sha256:ecc24f51eeec6ab7eecc2f9724e8272c2fb191c2e93cf98109120c2cace69750 + # via + # -r requirements.in + # myst-parser +mdurl==0.1.0 \ + --hash=sha256:40654d6dcb8d21501ed13c21cc0bd6fc42ff07ceb8be30029e5ae63ebc2ecfda \ + --hash=sha256:94873a969008ee48880fb21bad7de0349fef529f3be178969af5817239e9b990 + # via markdown-it-py mock==4.0.2 \ --hash=sha256:3f9b2c0196c60d21838f307f5825a7b86b678cedc58ab9e50a8988187b4d81e0 \ --hash=sha256:dd33eb70232b6118298d516bbcecd26704689c386594f0f3c4f13867b2c56f72 # via -r requirements.in +myst-parser==0.16.1 \ + --hash=sha256:617a90ceda2162ebf81cd13ad17d879bd4f49e7fb5c4f177bb905272555a2268 \ + --hash=sha256:a6473b9735c8c74959b49b36550725464f4aecc4481340c9a5f9153829191f83 + # via -r requirements.in packaging==20.4 \ --hash=sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8 \ --hash=sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181 @@ -243,6 +267,9 @@ pyrsistent==0.18.0 \ python-dateutil==2.8.2 \ --hash=sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86 \ --hash=sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9 + # via + # -r requirements.in + # botocore python-frontmatter==0.5.0 \ --hash=sha256:a7dcdfdaf498d488dce98bfa9452f8b70f803a923760ceab1ebd99291d98d28a \ --hash=sha256:a9c2e90fc38e9f0c68d8b82299040f331ca3b8525ac7fa5f6beffef52b26c426 @@ -269,11 +296,8 @@ pyyaml==5.3.1 \ --hash=sha256:d13155f591e6fcc1ec3b30685d50bf0711574e2c0dfffd7644babf8b5102ca1a # via # -r requirements.in + # myst-parser # python-frontmatter -recommonmark==0.7.1 \ - --hash=sha256:1b1db69af0231efce3fa21b94ff627ea33dee7079a01dd0a7f8482c3da148b3f \ - --hash=sha256:bdb4db649f2222dcd8d2d844f0006b958d627f732415d399791ee436a3686d67 - # via -r requirements.in redo==2.0.3 \ --hash=sha256:36784bf8ae766e14f9db0e377ccfa02835d648321d2007b6ae0bf4fd612c0f94 \ --hash=sha256:71161cb0e928d824092a5f16203939bbc0867ce4c4685db263cf22c3ae7634a8 @@ -334,9 +358,16 @@ snowballstemmer==2.0.0 \ # via # -r requirements.in # sphinx -Sphinx==4.3.1 \ +sphinx==4.3.1 \ --hash=sha256:048dac56039a5713f47a554589dc98a442b39226a2b9ed7f82797fcb2fe9253f \ --hash=sha256:32a5b3e9a1b176cc25ed048557d4d3d01af635e6b76c5bc7a43b0a34447fbd45 + # via + # -r requirements.in + # myst-parser + # sphinx-copybutton + # sphinx-js + # sphinx-panels + # sphinx-rtd-theme sphinx-copybutton==0.4.0 \ --hash=sha256:4340d33c169dac6dd82dce2c83333412aa786a42dd01a81a8decac3b130dc8b0 \ --hash=sha256:8daed13a87afd5013c3a9af3575cc4d5bec052075ccd3db243f895c07a689386 @@ -356,6 +387,7 @@ sphinx-panels==0.6.0 \ sphinx-rtd-theme==1.0.0 \ --hash=sha256:4d35a56f4508cfee4c4fb604373ede6feae2a306731d533f409ef5c3496fdbd8 \ --hash=sha256:eec6d497e4c2195fa0e8b2016b337532b8a699a68bcb22a512870e16925c6a5c + # via -r requirements.in sphinxcontrib-applehelp==1.0.2 \ --hash=sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a \ --hash=sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58 @@ -383,6 +415,7 @@ sphinxcontrib-jsmath==1.0.1 \ sphinxcontrib-mermaid==0.7.1 \ --hash=sha256:3e20de1937c30dfa807e446bf99983d73d0dd3dc5c6524addda59800fe928762 \ --hash=sha256:aa8a40b50ec86ad12824b62180240ca52a9bda8424455d7eb252eae9aa5d293c + # via -r requirements.in sphinxcontrib-qthelp==1.0.3 \ --hash=sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72 \ --hash=sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6