Skip to content

Commit

Permalink
Merge pull request #188 from tynanford/master
Browse files Browse the repository at this point in the history
add readthedocs config file
  • Loading branch information
shroffk committed Feb 7, 2024
2 parents 6ee6ddb + 97f5002 commit 97b1086
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
15 changes: 15 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.12"

# Build from the docs/ directory with Sphinx
sphinx:
configuration: src/site/sphinx/conf.py

# Explicitly set the version of Python and its requirements
python:
install:
- requirements: src/site/sphinx/requirements.txt
4 changes: 0 additions & 4 deletions src/site/sphinx/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# -*- coding: utf-8 -*-
import sys, os
from recommonmark.parser import CommonMarkParser

project = u'Olog Service'
copyright = u'Copyright (c) 2010-2020 Brookhaven National Laboratory \n Copyright (c) 2010-2020 Helmholtz-Zentrum Berlin für Materialien und Energie GmbH \n All rights reserved. Use is subject to license terms and conditions.'
Expand All @@ -19,9 +18,6 @@
exclude_trees = ['.build']
source_suffix = ['.rst', '.md']
source_encoding = 'utf-8-sig'
source_parsers = {
'.md': CommonMarkParser
}

# HTML options
html_theme = 'sphinx_rtd_theme'
Expand Down
3 changes: 3 additions & 0 deletions src/site/sphinx/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx==7.2.6
sphinx_rtd_theme==2.0.0
readthedocs-sphinx-search==0.3.2

0 comments on commit 97b1086

Please sign in to comment.