use furo

Author: zh1peng

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      = .
+
+# 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)

doctrees/environment.pickle

@@ -0,0 +1,42 @@
+@ECHO OFF
+pushd %~dp0
+
+REM Command file for building Sphinx documentation on Windows
+
+REM Set up defaults
+IF "%SPHINXBUILD%"=="" SET SPHINXBUILD=sphinx-build
+SET SOURCEDIR=source
+SET BUILDDIR=docs
+
+REM Check if sphinx-build exists
+%SPHINXBUILD% >NUL 2>&1
+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 https://www.sphinx-doc.org/
+    EXIT /B 1
+)
+
+REM If no argument is given, show help
+IF "%1"=="" GOTO help
+
+REM Run the sphinx-build target
+IF "%1"=="html" (
+    %SPHINXBUILD% -b html %SOURCEDIR% %BUILDDIR%
+    echo.> %BUILDDIR%\.nojekyll
+) ELSE (
+    %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+)
+
+GOTO end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doctrees/index.doctree

@@ -0,0 +1,27 @@
+<div class="entry-cards" style="margin-top: 1rem; display: flex; flex-direction: column; gap: 1rem;">
+
+  <div class="card" style="border: 1px solid var(--color-sidebar-border); padding: 0.75rem; border-radius: 6px;">
+    <p style="margin: 0.25rem 0;"><strong>📄 TAPS</strong></p>
+    <p style="margin: 0; font-size: 0.85em;">A standardized format for cognitive tasks, providing reproducible task specifications.</p>
+    <a href="{{ pathto('taps') }}" style="font-size: 0.8em;">Learn more →</a>
+  </div>
+
+  <div class="card" style="border: 1px solid var(--color-sidebar-border); padding: 0.75rem; border-radius: 6px;">
+    <p style="margin: 0.25rem 0;"><strong>🧱 PsyFlow</strong></p>
+    <p style="margin: 0; font-size: 0.85em;">A development framework for building cognitive tasks with easy integration of TAPS.</p>
+    <a href="{{ pathto('psyflow') }}" style="font-size: 0.8em;">Learn more →</a>
+  </div>
+
+  <div class="card" style="border: 1px solid var(--color-sidebar-border); padding: 0.75rem; border-radius: 6px;">
+    <p style="margin: 0.25rem 0;"><strong>✅ Tasks</strong></p>
+    <p style="margin: 0; font-size: 0.85em;">A library of common cognitive tasks ready to use like Go/No–Go, Stroop, Reaction-Time...</p>
+    <a href="{{ pathto('tasks_index') }}" style="font-size: 0.8em;">Browse all →</a>
+  </div>
+
+  <div class="card" style="border: 1px solid var(--color-sidebar-border); padding: 0.75rem; border-radius: 6px;">
+    <p style="margin: 0.25rem 0;"><strong>💡 Future Directions</strong></p>
+    <p style="margin: 0; font-size: 0.85em;">Exploring LLM-based generation of cognitive tasks driven by natural language.</p>
+    <a href="{{ pathto('future') }}" style="font-size: 0.8em;">Learn more →</a>
+  </div>
+
+</div>

make.bat

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'TaskBeacon'
+copyright = '2025, zhipeng'
+author = 'zhipeng'
+release = ''
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+# html_theme_options = {
+#     "announcement": "This is in development!",
+# }
+html_static_path = ['_static']
+
+html_logo = "_static/logo.png"  # add later if you want
+html_theme_options = {
+    "sidebar_hide_name": True,
+    "light_logo": "logo-light.png",
+    "dark_logo": "logo-dark.png",
+}
+
+html_sidebars = {
+    "**": [ 
+        "sidebar/entries.html",      
+        # any further items here would float on the left again
+    ]
+}
+
+
+# Enable extensions
+extensions = [
+    "myst_parser",                      # Markdown support
+    "sphinx.ext.autodoc",              # Auto pull docstrings
+    "sphinx.ext.napoleon",             # Google/Numpy style docstrings
+    "sphinx_autodoc_typehints",        # Type hints in docs
+]
+
+
+# Allow both .rst and .md files
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+
+