Skip to content

Commit 2ddac46

Browse files
committed
Add requirements for documentation for readthedocs.
1 parent 24b5601 commit 2ddac46

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

.readthedocs.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# .readthedocs.yml
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+
12+
# Optionally build your docs in additional formats such as PDF and ePub
13+
formats: all
14+
15+
# Optionally set the version of Python and requirements required to build your docs
16+
python:
17+
install:
18+
- requirements: docs/requirements.txt
19+
- requirements: requirements.txt

README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ With Eiffellib you can start subscribing to and publish valid Eiffel messages qu
1313

1414
It is designed to be fast and easy to start using while still being production quality.
1515

16+
Documentation: https://eiffellib.readthedocs.io/en/latest/
17+
1618
.. code-block:: python
1719
:caption: Subscribing to an event
1820

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pyscaffold==2.5.10
2+
m2r==0.2.1

0 commit comments

Comments
 (0)