Skip to content

Commit

Permalink
docs: Remove references to header_id.md page.
Browse files Browse the repository at this point in the history
The page was removed along with the extension in 1127013.

Also ensure any future MkDocs warnings cause the build to fail in the tests
so we don't introduce similar errors in the future.
  • Loading branch information
mitya57 authored and waylan committed Jan 13, 2018
1 parent cd73243 commit 6d1537a
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 9 deletions.
2 changes: 1 addition & 1 deletion checkspelling.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

echo "Building docs..."
mkdocs build
mkdocs build --strict
if [ $? -ne 0 ]; then
exit 1
fi
Expand Down
2 changes: 1 addition & 1 deletion docs/change_log/release-2.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ release, there are a few backward-incompatible changes to note:
you should now set them on the class. See the [Library
Reference](../reference.md) for the options available.

* If you have been using the [HeaderId](../extensions/header_id.md) extension to
* If you have been using the HeaderId extension to
define custom ids on headers, you will want to switch to using the new
[Attribute List](../extensions/attr_list.md) extension. The HeaderId extension
now only auto-generates ids on headers which have not already had ids defined.
Expand Down
4 changes: 1 addition & 3 deletions docs/change_log/release-2.6.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ explanation of the current behavior.

### HeaderId Extension Pending Deprecation

The [HeaderId][hid] Extension is pending deprecation and will raise a
The HeaderId Extension is pending deprecation and will raise a
**`PendingDeprecationWarning`** in version 2.6. The extension will be deprecated
in the next release and raise an error in the release after that. Use the [Table
of Contents][TOC] Extension instead, which offers most of the features of the
Expand All @@ -153,8 +153,6 @@ defined in the HeaderId Extension should note that those functions are now
defined in the Table of Contents extension and should adjust their import
statements accordingly (`from markdown.extensions.toc import slugify, unique`).

[hid]: ../extensions/header_id.md

### The `configs` Keyword is Deprecated

Positional arguments and the `configs` keyword on the
Expand Down
1 change: 0 additions & 1 deletion docs/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ Extension | Entry Point | Dot Notation
[Smart Strong]: smart_strong.md
[Admonition]: admonition.md
[CodeHilite]: code_hilite.md
[HeaderId]: header_id.md
[Meta-Data]: meta_data.md
[New Line to Break]: nl2br.md
[Sane Lists]: sane_lists.md
Expand Down
3 changes: 0 additions & 3 deletions docs/extensions/meta_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,6 @@ Compatible Extensions
The following extensions are currently known to work with the Meta-Data
extension. The keywords they are known to support are also listed.

* [HeaderId](header_id.md)
* `header_level`
* `header_forceid`
* [WikiLinks](wikilinks.md)
* `wiki_base_url`
* `wiki_end_url`
Expand Down

0 comments on commit 6d1537a

Please sign in to comment.