Skip to content

Commit dd7d429

Browse files
committedFeb 20, 2025··
Fix readthedocs builds
1 parent a97139a commit dd7d429

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed
 

‎.readthedocs.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-24.04
10+
tools:
11+
python: "3.13"
12+
jobs:
13+
post_create_environment:
14+
- python -m pip install sphinx_rtd_theme
15+
16+
# Build documentation in the "docs/" directory with Sphinx
17+
sphinx:
18+
configuration: docs/conf.py

‎docs/conf.py

+7-5
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
extensions = [
3838
'sphinx.ext.autodoc',
3939
'sphinx.ext.viewcode',
40+
'sphinx_rtd_theme',
4041
]
4142

4243
# Add any paths that contain templates here, relative to this directory.
@@ -53,16 +54,16 @@
5354

5455
# General information about the project.
5556
project = u'senaite.jsonapi'
56-
copyright = u'2017-2020, Riding Bytes & Naralabs'
57+
copyright = u'2017-2025, Riding Bytes & Naralabs'
5758

5859
# The version info for the project you're documenting, acts as replacement for
5960
# |version| and |release|, also used in various other places throughout the
6061
# built documents.
6162
#
6263
# The short X.Y version.
63-
version = '1.2.3'
64+
version = '2.6.0'
6465
# The full version, including alpha/beta/rc tags.
65-
release = '1.2.3'
66+
release = '2.6.0'
6667

6768
# The language for content autogenerated by Sphinx. Refer to documentation
6869
# for a list of supported languages.
@@ -107,7 +108,7 @@
107108

108109
# The theme to use for HTML and HTML Help pages. See the documentation for
109110
# a list of builtin themes.
110-
html_theme = 'default'
111+
html_theme = 'sphinx_rtd_theme'
111112

112113
# Theme options are theme-specific and customize the look and feel of a theme
113114
# further. For a list of options available for each theme, see the
@@ -250,7 +251,8 @@
250251
# dir menu entry, description, category)
251252
texinfo_documents = [
252253
('index', 'senaitejsonapi', u'senaite.jsonapi Documentation',
253-
u'Riding Bytes & Naralabs', 'senaitejsonapi', 'One line description of project.',
254+
u'Riding Bytes & Naralabs', 'senaitejsonapi',
255+
'A RESTful JSON API for SENAITE LIMS',
254256
'Miscellaneous'),
255257
]
256258

0 commit comments

Comments
 (0)
Please sign in to comment.