Skip to content

Commit 396c1e7

Browse files
committed
Add python-isal as a dependency to readthedocs
1 parent 672d926 commit 396c1e7

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ installation options check the `documentation
102102
python-isal as a dependency in your project
103103
-------------------------------------------
104104

105+
.. dependency start
106+
105107
Python-isal supports a limited amount of platforms for which wheels have been
106108
made available. To prevent your users from running into issues when installing
107109
your project please list a python-isal dependency as follows.
@@ -118,6 +120,8 @@ your project please list a python-isal dependency as follows.
118120
"(platform.machine == 'x86_64' or platform.machine == 'AMD64')": ['isal']
119121
},
120122

123+
.. dependency end
124+
121125
Differences with zlib and gzip modules
122126
--------------------------------------
123127

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,15 @@ it is available on conda-forge.
8484

8585
.. _differences-with-zlib-and-gzip-modules:
8686

87+
===========================================
88+
python-isal as a dependency in your project
89+
===========================================
90+
91+
.. include:: includes/README.rst
92+
:start-after: .. dependency start
93+
:end-before: .. dependency end
94+
95+
8796
======================================
8897
Differences with zlib and gzip modules
8998
======================================

0 commit comments

Comments
 (0)