Skip to content

Commit 2861899

Browse files
authored
Fix ReadTheDocs rendering (google#1256)
* Updates to rtd config * Updates * Updates * Updates to docs
1 parent ab378f0 commit 2861899

File tree

3 files changed

+32
-9
lines changed

3 files changed

+32
-9
lines changed

.readthedocs.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.10"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
# If using Sphinx, optionally build your docs in additional formats such as PDF
19+
# formats:
20+
# - pdf
21+
22+
# Optionally declare the Python requirements required to build your docs
23+
python:
24+
install:
25+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,14 @@
1515
# sys.path.insert(0, os.path.abspath('.'))
1616

1717
from __future__ import unicode_literals
18-
import re
1918

20-
from recommonmark.parser import CommonMarkParser
2119
from recommonmark.transform import AutoStructify
2220
from docutils import nodes, transforms
2321

2422
# -- Project information -----------------------------------------------------
2523

2624
project = 'Turbinia'
27-
copyright = '2022, Google Inc'
25+
copyright = '2023, Google Inc'
2826
author = 'Turbinia maintainers'
2927

3028
# -- General configuration ---------------------------------------------------
@@ -81,7 +79,7 @@
8179
# Output file base name for HTML help builder.
8280
htmlhelp_basename = 'turbiniadoc'
8381

84-
html_logo = "images/turbinia-logo.jpg"
82+
html_logo = 'images/turbinia-logo.jpg'
8583

8684

8785
class ProcessLink(transforms.Transform):

docs/requirements.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
docutils
2-
pyparsing
3-
recommonmark
4-
sphinx
5-
sphinx_rtd_theme
1+
docutils==0.17.1
2+
pyparsing==2.4.7
3+
recommonmark==0.7.1
4+
sphinx==5.3.0
5+
sphinx_rtd_theme==1.1.1

0 commit comments

Comments
 (0)