Skip to content

Commit 2637b7c

Browse files
authored
Merge pull request #6 from executablebooks/fix-rtd
🐛 FIX: RTD fail - install extension locally
2 parents de754d4 + 3f13395 commit 2637b7c

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

.readthedocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ sphinx:
1212
python:
1313
version: 3.7
1414
install:
15-
- requirements: docs/requirements.txt
15+
- method: pip
16+
path: .
17+
extra_requirements:
18+
- rtd

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ extensions = ["sphinx_exercise"]
2929

3030
## Documentation
3131

32-
See the [Sphinx Exercise documentation](https://sphinx-exercise.readthedocs.io/en/latest/) for more information.
32+
See the [Sphinx Exercise documentation](https://ebp-sphinx-exercise.readthedocs.io/en/latest/) for more information.
3333

3434

3535
## Contributing
3636

3737
We welcome all contributions! See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details, and below for guidance specific to sphinx-exercise.
3838

3939

40-
[rtd-badge]: https://readthedocs.org/projects/sphinx-exercise/badge/?version=latest
41-
[rtd-link]: https://sphinx-exercise.readthedocs.io/en/latest/?badge=latest
40+
[rtd-badge]: https://readthedocs.org/projects/ebp-sphinx-exercise/badge/?version=latest
41+
[rtd-link]: https://ebp-sphinx-exercise.readthedocs.io/en/latest/?badge=latest
4242
[github-ci]: https://github.com/executablebooks/sphinx-exercise/workflows/continuous-integration/badge.svg?branch=master
4343
[github-link]: https://github.com/executablebooks/sphinx-exercise
4444
[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-exercise/branch/master/graph/badge.svg

docs/source/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ syntax
88
testing
99
```
1010

11-
[![Documentation Status](https://readthedocs.org/projects/sphinx-exercise/badge/?version=latest)](https://sphinx-exercise.readthedocs.io/en/latest/?badge=latest)
11+
12+
[![Documentation Status][rtd-badge]][rtd-link]
13+
[![Github-CI][github-ci]][github-link]
14+
[![Coverage Status][codecov-badge]][codecov-link]
1215

1316
**An exercise extension for Sphinx**.
1417

@@ -64,3 +67,12 @@ extensions = ["sphinx_exercise"]
6467
```
6568

6669
you may then build using `make html` and the extension will be used by your `Sphinx` project.
70+
71+
72+
73+
[rtd-badge]: https://readthedocs.org/projects/ebp-sphinx-exercise/badge/?version=latest
74+
[rtd-link]: https://ebp-sphinx-exercise.readthedocs.io/en/latest/?badge=latest
75+
[github-ci]: https://github.com/executablebooks/sphinx-exercise/workflows/continuous-integration/badge.svg?branch=master
76+
[github-link]: https://github.com/executablebooks/sphinx-exercise
77+
[codecov-badge]: https://codecov.io/gh/executablebooks/sphinx-exercise/branch/master/graph/badge.svg
78+
[codecov-link]: https://codecov.io/gh/executablebooks/sphinx-exercise

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ extras = testing
1919
deps =
2020
sphinx2: sphinx>=2,<3
2121
sphinx3: sphinx>=3,<4
22-
commands = pytest {posargs}
22+
commands = pytest --verbose {posargs}
2323

2424
[testenv:docs-{update,clean}]
2525
extras = rtd

0 commit comments

Comments
 (0)