Skip to content

Commit ee978d2

Browse files
author
Dominik Gresch
committed
Add readthedocs config and add sphinx-pyreverse to doc requirements
1 parent 6453f07 commit ee978d2

File tree

3 files changed

+26
-8
lines changed

3 files changed

+26
-8
lines changed

.gitignore

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,6 @@ MANIFEST
3838
*.tar.gz
3939
files*.txt
4040

41-
# ignoring the _ptools git
42-
z2pack/_ptools/.git
43-
z2pack/_ptools/.gitignore
44-
45-
# selectively choose _ptools
46-
z2pack/_ptools/*
47-
4841
# debug folder
4942
debug
5043

@@ -59,3 +52,6 @@ tests/.pytest_cache
5952
.coverage
6053
.coverage*
6154
htmlcov
55+
56+
# editors
57+
.vscode

.readthedocs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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 doc/ directory with Sphinx
9+
sphinx:
10+
configuration: doc/source/conf.py
11+
12+
# Optionally build your docs in additional formats such as PDF and ePub
13+
formats: []
14+
15+
# Optionally set the version of Python and requirements required to build your docs
16+
python:
17+
version: 3.7
18+
install:
19+
- method: pip
20+
path: .
21+
extra_requirements:
22+
- doc

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
EXTRAS = {
2828
'plot': ['matplotlib'],
2929
'tb': ['tbmodels>=1.1.1'],
30-
'doc': ['sphinx', 'sphinx_rtd_theme'],
30+
'doc': ['sphinx', 'sphinx_rtd_theme', 'sphinx-pyreverse'],
3131
'dev': [
3232
'prospector==1.1.2', 'pytest>=3.4', 'pytest-cov', 'yapf==0.24',
3333
'pre-commit==1.11.1', 'pylint==2.1.1'

0 commit comments

Comments
 (0)