Skip to content

Commit

Permalink
Hosting documentation on readthedocs.
Browse files Browse the repository at this point in the history
Updating sphinx docs and adding a readthedocs.yml file.
  • Loading branch information
alxmrs authored and naschmitz committed Aug 30, 2024
1 parent 18ef42b commit b48bbd0
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
print('pip environment:')
subprocess.run([sys.executable, '-m', 'pip', 'list']) # pylint: disable=subprocess-run-check

print(f'xee: {xee.__version__}, {xee.__file__}')
print(f'xee: {xee.__file__}')

# -- Project information -----------------------------------------------------

Expand Down

0 comments on commit b48bbd0

Please sign in to comment.