Skip to content

Commit a7705b8

Browse files
authored
Merge pull request #18 from jedymatt/add-docs
Added rtd config and update doc intro
2 parents 6820141 + b0d7e6a commit a7705b8

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build documentation in the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
builder: html
12+
fail_on_warning: true
13+
14+
# Optionally build your docs in additional formats such as PDF
15+
formats:
16+
- pdf
17+
18+
# Optionally set the version of Python and requirements required to build your docs
19+
python:
20+
version: "3.7"
21+
install:
22+
- requirements: docs/requirements.txt

docs/source/intro.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ execute this command to install necessary dependencies
2626
2727
pip install sqlalchemyseed[yaml]
2828
29+
Dependencies
30+
------------
31+
32+
Required dependencies
33+
34+
- SQAlchemy>=1.4.0
35+
36+
Optional dependencies
37+
38+
- yaml
39+
- PyYAML>=5.4.0
40+
2941
Getting Started
3042
---------------
3143

0 commit comments

Comments
 (0)