Skip to content

Commit a955e55

Browse files
author
William Grant
committed
point to doc build reqs
1 parent 11e5e28 commit a955e55

File tree

3 files changed

+25
-17
lines changed

3 files changed

+25
-17
lines changed

.readthedocs.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
version: 2
2+
3+
python:
4+
install:
5+
- requirements: docs/doc_requirements.txt

docs/conf.py

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,33 @@
88
import os
99
import sys
1010

11-
project = 'typed_python'
12-
copyright = '2022, Braxton McKee'
13-
author = 'Braxton McKee'
14-
release = '0.2.6'
11+
project = "typed_python"
12+
copyright = "2022, Braxton McKee"
13+
author = "Braxton McKee"
14+
release = "0.2.6"
1515

1616
# -- General configuration ---------------------------------------------------
1717
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1818

19-
extensions = ['myst_parser',
20-
'sphinx.ext.autodoc',
21-
'sphinx.ext.napoleon',
22-
'sphinx.ext.viewcode'
23-
]
19+
extensions = [
20+
"myst_parser",
21+
"sphinx.ext.autodoc",
22+
"sphinx.ext.napoleon",
23+
"sphinx.ext.viewcode",
24+
]
2425

25-
templates_path = ['_templates']
26-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
26+
source_suffix = {
27+
".rst": "restructuredtext",
28+
".md": "markdown",
29+
}
30+
31+
templates_path = ["_templates"]
32+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
2733

2834
# -- Options for HTML output -------------------------------------------------
2935
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3036

31-
html_theme = 'sphinx_book_theme'
32-
html_static_path = ['_static']
37+
html_theme = "sphinx_book_theme"
38+
html_static_path = ["_static"]
3339

34-
sys.path.insert(0, os.path.abspath('..'))
40+
sys.path.insert(0, os.path.abspath(".."))

docs/doc_requirements.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)