Skip to content

Commit

Permalink
Update config for readthedocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tompollard committed Jun 15, 2024
1 parent d6c6e8f commit e7ccbdb
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 8 deletions.
16 changes: 9 additions & 7 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@
# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
# install:
# - requirements: requirements.txt
install:
- path: .
- requirements: docs/requirements.txt
7 changes: 7 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
API
===

.. autosummary::
:toctree: generated

tableone
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = [] # ['_static']
html_static_path = [] # ['_static']


# -- Options for HTMLHelp output ------------------------------------------
Expand Down
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx>=2.1.0,!=3.1.0
sphinx-rtd-theme>=1.2.2
sphinx-prompt>=1.8.0
docutils!=0.18

0 comments on commit e7ccbdb

Please sign in to comment.