Skip to content

Commit 46ec928

Browse files
committed
Update config for ReadTheDocs
1 parent a91a068 commit 46ec928

File tree

3 files changed

+50
-5
lines changed

3 files changed

+50
-5
lines changed

.readthedocs.yaml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# .readthedocs.yaml
3+
# Read the Docs configuration file
4+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
5+
6+
# Required
7+
version: 2
8+
9+
# Set the version of Python and other tools you might need
10+
build:
11+
os: ubuntu-22.04
12+
tools:
13+
python: "3.11"
14+
# You can also specify other tool versions:
15+
# nodejs: "16"
16+
# rust: "1.55"
17+
# golang: "1.17"
18+
apt_packages:
19+
- build-essential
20+
- gmsh
21+
- calculix-ccx
22+
- libglu1-mesa
23+
24+
25+
# Build documentation in the docs/ directory with Sphinx
26+
sphinx:
27+
configuration: docs/conf.py
28+
29+
# If using Sphinx, optionally build your docs in additional formats such as PDF
30+
# formats:
31+
# - pdf
32+
33+
# Optionally declare the Python requirements required to build your docs
34+
python:
35+
install:
36+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
import sys, os
22
import mock
33

4+
sys.path.insert(0, os.path.abspath('../pyccx'))
5+
sys.path.insert(0, os.path.abspath('..'))
6+
47
from pyccx.version import __version__
58

69

710
# If extensions (or modules to document with autodoc) are in another directory,
811
# add these directories to sys.path here. If the directory is relative to the
912
# documentation root, use os.path.abspath to make it absolute, like shown here.
10-
sys.path.insert(0, os.path.abspath('..'))
1113

1214
# -- General configuration -----------------------------------------------------
1315

docs/requirements.txt

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
sphinx==4.5.0
1+
sphinx
22
sphinx-automodapi
3-
sphinx-autodoc-typehints==1.10.3
3+
sphinx-autodoc-typehints
44
sphinx-paramlinks
5+
sphinx_rtd_theme
56
autodocsumm
67
pypandoc
7-
m2r2
8-
gmsh>=4.14.0
8+
mock
9+
furo
10+
numpy
11+
matplotlib
12+
trimesh
13+
m2r2==0.3.4
14+
gmsh>=4.14.0
15+
docutils==0.21.2

0 commit comments

Comments
 (0)