Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,4 @@ dask_sql/jar
.next/
dask-worker-space/
node_modules/
docs/source/_build/
17 changes: 12 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-20.04
tools:
python: "3.8"
apt_packages:
- maven

sphinx:
configuration: docs/source/conf.py

python:
version: 3.8
install:
- method: setuptools
- requirements: docs/requirements-docs.txt
- method: pip
path: .

conda:
environment: docs/environment.yaml
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
Expand Down
153 changes: 0 additions & 153 deletions docs/environment.yaml

This file was deleted.

21 changes: 21 additions & 0 deletions docs/environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: dask-sql-docs
channels:
- conda-forge
- nodefaults
dependencies:
- python=3.9
- sphinx>=4.0.0
- sphinx-tabs
- dask-sphinx-theme>=2.0.3
- maven>=3.6.0
- dask>=2021.11.1
- pandas>=1.0.0
- fugue>=0.5.3
- jpype1>=1.0.2
- fastapi>=0.61.1
- uvicorn>=0.11.3
- tzlocal>=2.1
- prompt_toolkit
- pygments
- tabulate
- nest-asyncio
6 changes: 3 additions & 3 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

Expand All @@ -21,7 +21,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
echo.https://www.sphinx-doc.org/
exit /b 1
)

Expand Down
14 changes: 14 additions & 0 deletions docs/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
sphinx>=4.0.0
sphinx-tabs
dask-sphinx-theme>=2.0.3
dask>=2021.11.1
pandas>=1.0.0
fugue>=0.5.3
jpype1>=1.0.2
fastapi>=0.61.1
uvicorn>=0.11.3
tzlocal>=2.1
prompt_toolkit
pygments
tabulate
nest-asyncio
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/conf.py → docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_tabs.tabs",
"dask_sphinx_theme.ext.dask_config_sphinx_ext",
]

Expand Down Expand Up @@ -61,3 +62,6 @@

# Do not show type mappings
autodoc_typehints = "none"

# disable collapsible tabs
sphinx_tabs_disable_tab_closing = True
File renamed without changes.
File renamed without changes.
Loading