-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readthedocs.yaml for build documentations correct
- Loading branch information
1 parent
e65934b
commit 3ab2449
Showing
3 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the OS, Python version and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.10" | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: doc/conf.py | ||
fail_on_warning: true | ||
|
||
# Optionally build your docs in additional formats such as PDF and ePub | ||
formats: | ||
- epub | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- method: pip | ||
path: . | ||
extra_requirements: | ||
- doc | ||
- requirements: doc/requirements.txt | ||
|
||
# Don't install the package in editable mode | ||
# This ensures we're testing the actual installation | ||
python: | ||
install: | ||
- method: pip | ||
path: . | ||
- requirements: doc/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Documentation dependencies | ||
sphinx>=5.0.0,<6.0.0 | ||
sphinx-rtd-theme>=1.0.0 | ||
sphinxcontrib-applehelp>=1.0.4 | ||
sphinxcontrib-devhelp>=1.0.2 | ||
sphinxcontrib-htmlhelp>=2.0.0 | ||
sphinxcontrib-serializinghtml>=1.1.5 | ||
sphinxcontrib-qthelp>=1.0.3 | ||
docutils>=0.17.1 | ||
jinja2>=3.0.0 | ||
|
||
# Project dependencies | ||
django>=3.2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
build>=1.0.0 | ||
twine>=4.0.0 |