Developing docs

This commit is contained in:
hhh
2024-03-17 16:05:14 +02:00
parent b874525423
commit 2ffa837899
3 changed files with 35 additions and 3 deletions

31
.readthedocs.yaml Normal file
View File

@@ -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

View File

@@ -20,8 +20,8 @@ sys.path.insert(0, os.path.abspath("../."))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = "Datalite" project = "Datalite"
copyright = "2020, Ege Ozkan" copyright = "2020, Ege Ozkan; 2024, hhh"
author = "Ege Ozkan" author = "Ege Ozkan, hhh"
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = "v0.7.1" 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 # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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, # 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, # relative to this directory. They are copied after the builtin static files,

View File

@@ -1 +1,2 @@
Sphinx==3.2.0 Sphinx==3.2.0
furo