Readthedocs (#25)

* First commit with template * Update docs configs * Docs requirements * Requirements * Requirements * Requirements * Requirements * Using website demo * path typo * Update configs * Fail on warning false for now * Requirements * ESGPT partial config test * Remove bibtex * Project specifics * pypandoc * V1 * Remove pdf * Logo * Colours * API * API reference and other pages * Requirements * Remove linkify * Linkify dependency * Overview title * Customizations * Tutorial page * Colors * Colours * Colours * Change to terminology * Update docs * Doc changes * Formatting * Undo html
justin13601 · May 12, 2024 · 7ecbaaa · 7ecbaaa
1 parent 3f9f40e
commit 7ecbaaa
Show file tree

Hide file tree

Showing 16 changed files with 554 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # fail_on_warning: true
+# Optionally build your docs in additional formats such as PDF
+# formats:
+#   - pdf
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ESGPT Task Querying - Coming Soon...
+# ESGPTTaskQuerying
 
 ![](https://img.shields.io/badge/python-3.10-blue)
 
@@ -16,7 +16,7 @@ This README provides an overview of this feature, including a description of the
 
 Provided below are several examples of clinically-meaningful tasks that ESGPT Task Querying could easily extract subject cohorts for:
 
-![Task Schema Definition](./TaskSchemaDefinition.svg)
+![Task Schema Definition](ESGPTTaskQuerying/TaskSchemaDefinition.svg)
 
 ## Dependencies
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	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/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,9 @@
+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
+sphinx-collections
+sphinx_immaterial
+sphinx_subfigure
+nbsphinx
+myst_parser
+pypandoc
+linkify-it-py