Skip to content

Commit 0b569d1

Browse files
committed
rtd setup
1 parent f004990 commit 0b569d1

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

.readthedocs.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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-22.04
10+
tools:
11+
python: "3.10"
12+
13+
# Build documentation in the "docs/" directory with Sphinx
14+
sphinx:
15+
configuration: docs/conf.py
16+
17+
formats:
18+
- pdf
19+
- epub
20+
21+
python:
22+
install:
23+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
3+
# -- Project information
4+
5+
project = "Asyncio-rpc"
6+
copyright = "2023, Jelle Prins"
7+
author = "Jelle Prins"
8+
9+
release = "0.1"
10+
version = "0.1.0"
11+
12+
# -- General configuration
13+
14+
extensions = [
15+
"sphinx.ext.duration",
16+
"sphinx.ext.doctest",
17+
"sphinx.ext.autodoc",
18+
"sphinx.ext.autosummary",
19+
"sphinx.ext.intersphinx",
20+
]
21+
22+
intersphinx_mapping = {
23+
"python": ("https://docs.python.org/3/", None),
24+
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
25+
}
26+
intersphinx_disabled_domains = ["std"]
27+
28+
templates_path = ["_templates"]
29+
30+
# -- Options for HTML output
31+
32+
html_theme = "sphinx_rtd_theme"
33+
34+
# -- Options for EPUB output
35+
epub_show_urls = "footnote"

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx==7.1.2
2+
sphinx-rtd-theme==1.3.0rc1

0 commit comments

Comments
 (0)