Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Updates #201

Merged
merged 1 commit into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
python: "3.11"
python: "3.12"
sphinx:
configuration: doc/source/conf.py
python:
install:
- requirements: requirements.txt
- requirements: requirements_devel.txt
- requirements: requirements.txt
- requirements: requirements_devel.txt
13 changes: 7 additions & 6 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
# Disabling the extension because of https://github.com/sphinx-doc/sphinx/issues/13095
# 'sphinx.ext.viewcode',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -131,8 +132,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'OSCTiny.tex', 'OSC Tiny Documentation',
'Andreas Hasenkopf', 'manual'),
(master_doc, 'OSCTiny.tex', project + ' Documentation',
author, 'manual'),
]


Expand All @@ -141,7 +142,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'osctiny', 'OSC Tiny Documentation',
(master_doc, 'osctiny', project + ' Documentation',
[author], 1)
]

Expand All @@ -152,8 +153,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'OSCTiny', 'OSC Tiny Documentation',
author, 'OSCTiny', 'One line description of project.',
(master_doc, project, project + ' Documentation',
author, project, 'One line description of project.',
'Miscellaneous'),
]

Expand Down
Loading