Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up documentation build warnings #1486

Merged
merged 3 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions .github/workflows/docs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/tox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ jobs:
fail-fast: false
max-parallel: 4
matrix:
tox-env: [flake8, pep517check, checkspelling]
tox-env: [flake8, pep517check, checklinks, checkspelling]

env:
TOXENV: ${{ matrix.tox-env }}
Expand Down
2 changes: 1 addition & 1 deletion docs/change_log/release-2.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ What's New in Python-Markdown 2.4
Blocks] section for details. Thanks to [ryneeverett] for implementing this
feature.

[Markdown Inside HTML Blocks]: ../extensions/extra.md#nested-markdown-inside-html-blocks
[Markdown Inside HTML Blocks]: ../extensions/md_in_html.md
[ryneeverett]: https://github.com/ryneeverett

* The code blocks now support emphasizing some of the code lines. To use this
Expand Down
2 changes: 1 addition & 1 deletion docs/change_log/release-2.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Backwards-incompatible Changes
a string to the extension name will be deprecated in Python-Markdown
version 2.6 and will raise a **`PendingDeprecationWarning`** in 2.5. The
[`extension_configs`](../reference.md#extension_configs) keyword should
be used instead. See the [documentation](../reference.md#extension-configs)
be used instead. See the [documentation](../reference.md#extension_configs)
for a full explanation of the current behavior.

What's New in Python-Markdown 2.5
Expand Down
4 changes: 2 additions & 2 deletions docs/change_log/release-2.6.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ The previously documented method of appending the extension configuration
options as a string to the extension name is deprecated and will raise a
**`DeprecationWarning`** in version 2.6 and an error in 2.7. The
[`extension_configs`](../reference.md#extension_configs) keyword should be used
instead. See the [documentation](../reference.md#extension-configs) for a full
instead. See the [documentation](../reference.md#extension_configs) for a full
explanation of the current behavior.

### HeaderId Extension Pending Deprecation
Expand Down Expand Up @@ -214,7 +214,7 @@ Note the call to `super` to get the benefits of configuration handling from the
parent class. See the [documentation][config] for more information.

[config]: ../extensions/api.md#configsettings
[mext]: ../extensions/api.md#makeextension
[mext]: ../extensions/api.md#dot_notation

## What's New in Python-Markdown 2.6

Expand Down
3 changes: 2 additions & 1 deletion docs/extensions/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -801,7 +801,7 @@ When `markdown.Markdown` is passed the "name" of your extension as a dot notatio
(for example `path.to.module`), it will import the module and call the `makeExtension` function to initiate your
extension.

## Registries
## Registries { #registry }

The `markdown.util.Registry` class is a priority sorted registry which Markdown uses internally to determine the
processing order of its various processors and patterns.
Expand Down Expand Up @@ -884,3 +884,4 @@ assert someitem in registry
[setuptools]: https://packaging.python.org/key_projects/#setuptools
[Entry points]: https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins
[Packaging and Distributing Projects]: https://packaging.python.org/tutorials/distributing-packages/
[Inline Patterns]: #inline-patterns
4 changes: 2 additions & 2 deletions docs/extensions/md_in_html.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ enabled, the content of a raw HTML block-level element can be parsed as Markdown
on the opening tag. The `markdown` attribute will be stripped from the output, while all other attributes will be
preserved.

The `markdown` attribute can be assigned one of three values: [`"1"`](#1), [`"block"`](#block), or [`"span"`](#span).
The `markdown` attribute can be assigned one of three values: [`"1"`](#markdown1), [`"block"`](#block), or [`"span"`](#span).

!!! note

The expressions "block-level" and "span-level" as used in this document refer to an element's designation
according to the HTML specification. Whereas the `"span"` and `"block"` values assigned to the `markdown`
attribute refer to the Markdown parser's behavior.

### `markdown="1"` { #1 }
### `markdown="1"` { #markdown1 }

When the `markdown` attribute is set to `"1"`, then the parser will use the default behavior for that specific tag.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% extends "_base/attribute.html" %}
{% extends "_base/attribute.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ attribute.relative_filepath }}#L{{ attribute.lineno }}{% if attribute.endlineno > attribute.lineno %}-L{{ attribute.endlineno }}{% endif %}" title='View source code on GitHub'>&lsaquo;&rsaquo;</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% extends "_base/class.html" %}
{% extends "_base/class.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ class.relative_filepath }}#L{{ class.lineno }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% extends "_base/function.html" %}
{% extends "_base/function.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ function.relative_filepath }}#L{{ function.lineno }}{% if function.endlineno > function.lineno %}-L{{ function.endlineno }}{% endif %}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% extends "_base/module.html" %}
{% extends "_base/module.html.jinja" %}

{% block heading scoped %}
<a class="doc-source-link" href="{{ config.source.repo }}/tree/{{ config.source.tag }}/{{ module.relative_filepath }}" title="{{ config.source.title }}">&lsaquo;&rsaquo;</a>
Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,12 @@ nav:
not_in_nav: |
change_log/

validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn

markdown_extensions:
- extra
- admonition
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ testing = [
'pyyaml'
]
docs = [
'mkdocs>=1.5',
'mkdocs>=1.6',
'mkdocs-nature>=0.6',
'mdx_gh_links>=0.2',
"mkdocstrings[python]",
Expand Down
6 changes: 3 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ skip_install = true
extras = docs
deps = pyspelling
commands =
{envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml
{envpython} -m mkdocs build --config-file {toxinidir}/mkdocs.yml
{envpython} -m pyspelling --config {toxinidir}/.pyspelling.yml

[testenv:checklinks]
whitelist_externals = markdown-link-check
extras = docs
deps =
commands = {toxinidir}/checklinks.sh
commands = {envpython} -m mkdocs build --strict --config-file {toxinidir}/mkdocs.yml

[testenv:pep517check]
deps = pep517
Expand Down
Loading