Skip to content

Commit

Permalink
[documentation] #4055: Add ReadTheDocs config (#4056)
Browse files Browse the repository at this point in the history
Signed-off-by: Marin Veršić <marin.versic101@gmail.com>
  • Loading branch information
6r1d committed Nov 20, 2023
1 parent 9995600 commit be5ef5b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 41 deletions.
11 changes: 11 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'))
Expand Down
45 changes: 6 additions & 39 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit be5ef5b

Please sign in to comment.