Skip to content

Commit

Permalink
add readthedocs config file
Browse files Browse the repository at this point in the history
  • Loading branch information
nomis committed Mar 31, 2024
1 parent 017dae4 commit 6db5c69
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
9 changes: 9 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,9 @@
version: 2
build:
os: ubuntu-lts-latest
tools:
python: latest
python:
install:
- requirements: .readthedocs/requirements.txt
formats: all
1 change: 1 addition & 0 deletions .readthedocs/requirements.txt
@@ -0,0 +1 @@
sphinx-rtd-theme
6 changes: 5 additions & 1 deletion docs/conf.py
Expand Up @@ -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'
Expand All @@ -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)/.+']

0 comments on commit 6db5c69

Please sign in to comment.