Add minimal docs, RTD configuration

Author: khaeru

.gitignore

@@ -70,7 +70,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+doc/_build/
 
 # PyBuilder
 target/

.readthedocs.yaml

@@ -0,0 +1,12 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3"
+
+python:
+  install:
+  - method: pip
+    path: .
+    extras: docs

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

doc/_static/css/custom.css

@@ -0,0 +1,3 @@
+.navbar-brand .logo__image {
+    max-width: 70%;
+}

doc/_static/logo.png

@@ -0,0 +1,27 @@
+# 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 ---------------------------------------------------------------
+
+project = "TDC tools"
+copyright = "2023, Transport Data Commons Initiative"
+author = "Transport Data Commons Initiative"
+
+# -- General configuration -------------------------------------------------------------
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -----------------------------------------------------------
+
+html_theme = "sphinx_book_theme"
+html_static_path = ["_static"]
+html_logo = "_static/logo.png"
+
+html_theme_options = {"logo": {"text": project}}
+
+html_css_files = ["css/custom.css"]

doc/conf.py

@@ -0,0 +1,13 @@
+Transport Data Commons tools
+****************************
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/index.rst

@@ -31,6 +31,10 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+docs = [
+    "Sphinx",
+    "sphinx-book-theme",
+]
 tests = [
     "pytest",
     "pytest-cov",