diff --git a/.readthedocs.yml b/.readthedocs.yml index c9c187a..cf9e04d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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 \ No newline at end of file + install: + - path: . + - requirements: docs/requirements.txt diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..686f40f --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,7 @@ +API +=== + +.. autosummary:: + :toctree: generated + + tableone diff --git a/docs/conf.py b/docs/conf.py index 9c40f81..a512575 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 ------------------------------------------ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..765fb13 --- /dev/null +++ b/docs/requirements.txt @@ -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