Skip to content

Commit

Permalink
prepared necessary files for readthedocs integration
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Kloß committed Oct 13, 2023
1 parent a8bc3b5 commit 125c7b1
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 0 deletions.
19 changes: 19 additions & 0 deletions environment-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: networkunit

channels:

dependencies:
- python>=3.11


- sciunit >= 0.2.2
- jupyter >= 1.0.0
- tabulate >= 0.8.2
- networkx >= 2.1
- seaborn >= 0.8.1
- numpy >= 1.15.3
- odml >= 1.3.0
- opencv-python
- pip:
- neo>=0.10.0
- elephant >= 0.7.0
21 changes: 21 additions & 0 deletions readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# readthedocs version
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

sphinx:
builder: html
configuration: doc/conf.py

conda:
environment: ./environment-docs.yml

python:
install:
- method: pip
path: .
extra_requirements:
- docs
5 changes: 5 additions & 0 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Packages required to build docs (in addition to requirements-tutorials.rst)

jupyter>=1.0.0
sphinx>=7.2.5
nbsphinx>=0.9.3
3 changes: 3 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
with open('requirements.txt', 'r') as fp:
install_requires = fp.read()
extras_require = {}
for extra in ['docs']:
with open('requirements-{0}.txt'.format(extra)) as fp:
extras_require[extra] = fp.read()

setup(
name="networkunit",
Expand Down

0 comments on commit 125c7b1

Please sign in to comment.