From 2ffa8378992dd70a5d26084d441a4562379a7cd0 Mon Sep 17 00:00:00 2001 From: hhh Date: Sun, 17 Mar 2024 16:05:14 +0200 Subject: [PATCH] Developing docs --- .readthedocs.yaml | 31 +++++++++++++++++++++++++++++++ docs/conf.py | 6 +++--- docs/requirements.txt | 1 + 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..63feea2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,31 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 7936711..f807b17 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,8 +20,8 @@ sys.path.insert(0, os.path.abspath("../.")) # -- Project information ----------------------------------------------------- project = "Datalite" -copyright = "2020, Ege Ozkan" -author = "Ege Ozkan" +copyright = "2020, Ege Ozkan; 2024, hhh" +author = "Ege Ozkan, hhh" # The full version, including alpha/beta/rc tags release = "v0.7.1" @@ -48,7 +48,7 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # 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, diff --git a/docs/requirements.txt b/docs/requirements.txt index 0a67f40..2baed51 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ Sphinx==3.2.0 +furo