diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..bb8dc9d --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,9 @@ +version: 2 +build: + os: ubuntu-lts-latest + tools: + python: latest +python: + install: + - requirements: .readthedocs/requirements.txt +formats: all diff --git a/.readthedocs/requirements.txt b/.readthedocs/requirements.txt new file mode 100644 index 0000000..6c5d5d4 --- /dev/null +++ b/.readthedocs/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme diff --git a/docs/conf.py b/docs/conf.py index 03def9b..5a3f366 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,13 +3,14 @@ import os travis_ci = os.environ.get("TRAVIS") == 'true' +rtd = os.environ.get("READTHEDOCS") == 'True' needs_sphinx = '1.3' extensions = [] source_suffix = ['.rst'] project = u'mcu-uuid-telnet' -copyright = u'2019-2021, Simon Arlott' +copyright = u'2019-2024, Simon Arlott' author = u'Simon Arlott' master_doc = 'index' @@ -23,5 +24,8 @@ highlight_language = 'c++' todo_include_todos = False +if rtd: + html_theme = 'sphinx_rtd_theme' + linkcheck_timeout = 60 linkcheck_ignore = [r'https://github.com/.+/.+/(compare|commits)/.+']