Skip to content

Commit e7ccbdb

Browse files
committed
Update config for readthedocs.
1 parent d6c6e8f commit e7ccbdb

File tree

4 files changed

+21
-8
lines changed

4 files changed

+21
-8
lines changed

.readthedocs.yml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@
55
# Required
66
version: 2
77

8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.9"
13+
814
# Build documentation in the docs/ directory with Sphinx
915
sphinx:
1016
configuration: docs/conf.py
1117

12-
# Build documentation with MkDocs
13-
#mkdocs:
14-
# configuration: mkdocs.yml
15-
1618
# Optionally build your docs in additional formats such as PDF and ePub
1719
formats: all
1820

1921
# Optionally set the version of Python and requirements required to build your docs
2022
python:
21-
version: 3.7
22-
# install:
23-
# - requirements: requirements.txt
23+
install:
24+
- path: .
25+
- requirements: docs/requirements.txt

docs/api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
API
2+
===
3+
4+
.. autosummary::
5+
:toctree: generated
6+
7+
tableone

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
# Add any paths that contain custom static files (such as style sheets) here,
110110
# relative to this directory. They are copied after the builtin static files,
111111
# so a file named "default.css" will overwrite the builtin "default.css".
112-
html_static_path = [] # ['_static']
112+
html_static_path = [] # ['_static']
113113

114114

115115
# -- Options for HTMLHelp output ------------------------------------------

docs/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
sphinx>=2.1.0,!=3.1.0
2+
sphinx-rtd-theme>=1.2.2
3+
sphinx-prompt>=1.8.0
4+
docutils!=0.18

0 commit comments

Comments
 (0)