Skip to content

Commit 111557c

Browse files
authored
Integrate documentation to RTD (#29)
1 parent 0b62efc commit 111557c

File tree

3 files changed

+38
-89
lines changed

3 files changed

+38
-89
lines changed

.readthedocs.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
version: 2
2+
3+
formats: []
4+
5+
sphinx:
6+
builder: html
7+
configuration: docs/conf.py
8+
9+
build:
10+
image: latest
11+
12+
python:
13+
version: 3.7
14+
install:
15+
- method: pip
16+
path: .
17+
extra_requirements:
18+
- docs
19+
system_packages: true

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
 
88
<a href="https://github.com/BlueBrain/Atlas-Download-Tools/actions/workflows/run-tests.yml"><img src="https://github.com/BlueBrain/Atlas-Download-Tools/actions/workflows/run-tests.yml/badge.svg?branch=main" alt="Build status" /></a>
99
&emsp;
10+
<a href='https://atlas-download-tools.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/atlas-download-tools/badge/?version=latest' alt='Documentation Status' /></a>
11+
&emsp;
1012
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Black"></a>
1113
<a href="https://pycqa.github.io/isort/"><img src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336" alt="Isort"></a>
1214
<a href="http://www.pydocstyle.org/"><img src="https://img.shields.io/badge/docstrings-pydocstyle-informational" alt="Pydocstyle"></a>

requirements.txt

+17-89
Original file line numberDiff line numberDiff line change
@@ -15,102 +15,30 @@
1515
# You should have received a copy of the GNU Lesser General Public License
1616
# along with this program. If not, see <https://www.gnu.org/licenses/>.
1717

18-
aiohttp==3.7.4
19-
allensdk==2.11.2
20-
appdirs==1.4.4
21-
argschema==2.0.2
22-
async-timeout==3.0.1
23-
attrs==21.2.0
24-
bandit==1.7.0
25-
black==21.5b1
26-
boto3==1.17.21
27-
botocore==1.20.79
28-
certifi==2020.12.5
29-
chardet==4.0.0
18+
certifi==2021.5.30
19+
charset-normalizer==2.0.4
3020
click==8.0.1
31-
coverage==5.5
3221
cycler==0.10.0
33-
decorator==4.4.2
34-
distlib==0.3.1
35-
distro==1.5.0
36-
filelock==3.0.12
37-
flake8==3.9.2
38-
future==0.18.2
39-
gitdb==4.0.7
40-
GitPython==3.1.17
41-
Glymur==0.8.19
42-
h5py==2.10.0
43-
hdmf==2.4.0
44-
idna==2.10
22+
idna==3.2
4523
imageio==2.9.0
46-
importlib-metadata==4.0.1
47-
iniconfig==1.1.1
48-
isort==5.8.0
49-
Jinja2==2.11.3
50-
jmespath==0.10.0
51-
jsonschema==3.2.0
24+
importlib-metadata==4.6.3
5225
kiwisolver==1.3.1
53-
MarkupSafe==2.0.1
54-
marshmallow==3.0.0rc6
5526
matplotlib==3.4.2
56-
mccabe==0.6.1
57-
multidict==5.1.0
58-
mypy-extensions==0.4.3
59-
ndx-events==0.2.0
60-
nest-asyncio==1.2.0
61-
networkx==2.5.1
62-
numexpr==2.7.3
63-
numpy==1.20.3
64-
opencv-python==4.5.2.52
65-
packaging==20.9
66-
pandas==0.25.3
67-
pathspec==0.8.1
68-
patsy==0.5.1
69-
pbr==5.6.0
70-
Pillow==8.2.0
71-
pluggy==0.13.1
72-
psycopg2-binary==2.8.6
73-
py==1.10.0
74-
pycodestyle==2.7.0
75-
pydocstyle==6.1.1
76-
pyflakes==2.3.1
77-
pynrrd==0.4.2
78-
pynwb==1.5.0
27+
networkx==2.6.2
28+
numpy==1.21.1
29+
opencv-python==4.5.3.56
30+
pandas==1.3.1
31+
Pillow==8.3.1
7932
pyparsing==2.4.7
80-
pyrsistent==0.17.3
81-
pytest==6.2.4
82-
pytest-cov==2.12.0
83-
pytest-mock==3.6.1
84-
python-dateutil==2.8.1
33+
python-dateutil==2.8.2
8534
pytz==2021.1
8635
PyWavelets==1.1.1
87-
PyYAML==5.4.1
88-
regex==2021.4.4
89-
requests==2.25.1
90-
requests-toolbelt==0.9.1
91-
ruamel.yaml==0.17.4
92-
ruamel.yaml.clib==0.2.2
93-
s3transfer==0.3.7
94-
scikit-build==0.11.1
95-
scikit-image==0.16.2
96-
scipy==1.6.3
97-
seaborn==0.11.1
98-
semver==2.13.0
99-
SimpleITK==2.0.2
100-
simplejson==3.17.2
36+
requests==2.26.0
37+
scikit-image==0.18.2
38+
scipy==1.7.1
10139
six==1.16.0
102-
smmap==4.0.0
103-
snowballstemmer==2.1.0
104-
statsmodels==0.12.2
105-
stevedore==3.3.0
106-
tables==3.6.1
107-
toml==0.10.2
108-
tox==3.23.1
109-
tqdm==4.61.0
110-
typed-ast==1.4.3
40+
tifffile==2021.7.30
11141
typing-extensions==3.10.0.0
112-
urllib3==1.26.4
113-
virtualenv==20.4.7
114-
xarray==0.15.1
115-
yarl==1.6.3
116-
zipp==3.4.1
42+
urllib3==1.26.6
43+
zipp==3.5.0
44+

0 commit comments

Comments
 (0)