Skip to content

Commit e827067

Browse files
committed
Run mkdocs build in strict mode
1 parent 8783579 commit e827067

File tree

5 files changed

+6
-11
lines changed

5 files changed

+6
-11
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
# Python linting.
2929
- tox -e lint
3030
# Docs website build.
31-
- poetry run mkdocs build
31+
- poetry run mkdocs build --strict
3232
# Package build, incl. publishing an experimental pre-release via GitHub Pages for builds on `master`.
3333
- cat pyproject.toml| awk '{sub(/^version = .+/,"version = \"0.0.0.dev\"")}1' > pyproject.toml.tmp && mv pyproject.toml.tmp pyproject.toml
3434
- npm run build

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ The project’s documentation website is built with [MkDocs](https://www.mkdocs.
6262

6363
```sh
6464
# One-off build.
65-
poetry run mkdocs build
65+
poetry run mkdocs build --strict
6666
# Rebuild the docs as you work on them
67-
poetry run mkdocs serve
67+
poetry run mkdocs serve --strict
6868
```
6969

7070
## Running the tests

docs/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/reference/known-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ context:
6363

6464
See [#87](https://github.com/torchbox/django-pattern-library/issues/87). There is currently no support for trying out a single component with different variations in context or tag overrides.
6565

66-
This can be worked around by creating pattern-library-only templates, see [Multiple template variants](../recipes/multiple-variants.md)
66+
This can be worked around by creating pattern-library-only templates, see [Multiple template variants](../guides/multiple-variants.md)
6767

6868
## Can’t mock each use of a template tag with different attributes
6969

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ site_url:
44
edit_uri: edit/master/docs/
55

66
repo_name: django-pattern-library
7-
dev_addr: 0.0.0.0:8001
7+
dev_addr: localhost:8001
88
theme:
99
name: material
1010
font: false
@@ -36,7 +36,7 @@ nav:
3636
- 'Workflows that work': 'guides/workflows-that-work.md'
3737
- 'Guides':
3838
- 'Customizing rendering': 'guides/customizing-template-rendering.md'
39-
- 'Multiple variants': 'recipes/multiple-variants.md'
39+
- 'Multiple variants': 'guides/multiple-variants.md'
4040
- 'Reuse across projects': 'guides/reuse-across-projects.md'
4141
- 'Recipes':
4242
- 'Inclusion tags': 'recipes/inclusion-tags.md'

0 commit comments

Comments
 (0)