Skip to content

Commit 559cc64

Browse files
committed
Configure read the docs and rename doc directory to standard docs
1 parent 6e90a1e commit 559cc64

17 files changed

Lines changed: 32 additions & 2 deletions

.readthedocs.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Copyright 2025 Center for Digital Humanities, Princeton University
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
# Read the Docs configuration file
5+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
6+
7+
# Required
8+
version: 2
9+
10+
# Set the OS, Python version, and other tools you might need
11+
build:
12+
os: ubuntu-24.04
13+
tools:
14+
python: "3.12"
15+
16+
# Build documentation in the "docs/" directory with Sphinx
17+
sphinx:
18+
configuration: docs/conf.py
19+
20+
# Optionally, but recommended,
21+
# declare the Python requirements required to build your documentation
22+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
23+
python:
24+
install:
25+
- method: pip
26+
path: .
27+
# extra_requirements:
28+
# - docs
29+
30+

DEVNOTES.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ To run unit tests for a specific module, use syntax like this::
3232

3333
pytest test/test_xpath.py
3434

35-
To generate sphinx documentation::
35+
To compile sphinx documentation::
3636

37-
cd doc
37+
cd docs
3838
make html
3939

4040
XML catalog
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)