diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000000..19ac519a4b9 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,11 @@ +--- +version: 2 +build: + os: ubuntu-22.04 + tools: + python: "3.11" +sphinx: + configuration: docs/source/conf.py +python: + install: + - requirements: docs/source/requirements.txt diff --git a/docs/source/conf.py b/docs/source/conf.py index b982de38e5d..bd34c2a643e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -122,14 +122,14 @@ # Read variables for # common settings and locale: with open('common.yaml', 'r') as stream: - common = yaml.load(stream) + common = yaml.safe_load(stream) project = common.get('project') documentation = common.get('documentation') description = common.get('description') copyright = common.get('copyright') author = common.get('author') with open('locale.yaml', 'r') as stream: - locale = yaml.load(stream) + locale = yaml.safe_load(stream) language = locale.get('language') if locale.get('locale_dirs'): print("Setting locale dir to " + locale.get('locale_dirs')) diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 0be54a6c1ed..69aa62e7e13 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -1,40 +1,7 @@ -alabaster==0.7.10 -argh==0.26.2 -Babel==2.9.1 -backports-abc==0.5 -certifi==2023.7.22 -chardet==3.0.4 -docopt==0.6.2 -docutils==0.14 -idna==2.6 -imagesize==0.7.1 -Jinja2>=3.1.2 -livereload==2.5.1 -MarkupSafe>=2.1.2 -pathtools==0.1.2 -pipreqs==0.4.12 -port-for==0.3.1 -protobuf==3.18.3 -Pygments==2.15.0 -pytz>=2022.7.1 -PyYAML==5.4 -requests -restructuredtext-lint==1.1.2 -singledispatch==3.4.0.3 -six==1.11.0 -snowballstemmer==1.2.1 -Sphinx==5.1.1 -sphinx-autobuild==0.7.1 -sphinx-intl==0.9.11 -sphinx-rtd-theme==0.4.2 -sphinxcontrib-websupport==1.0.1 -tornado==6.3.3 -typing==3.6.2 -urllib3 -watchdog==0.8.3 -yarg==0.1.9 -mistune==2.0.3 +Sphinx==7.2.6 +sphinx-rtd-theme==1.3.0 +sphinxext-remoteliteralinclude==0.4.0 +pyyaml==6.0 +pygments_lexer_solidity==0.7.0 m2r2==0.3.2 -pygments-lexer-solidity -sphinxext-remoteliteralinclude -m2r2==0.3.3 +