Skip to content

Commit

Permalink
Merge branch 'master' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
hukkin authored Oct 4, 2024
2 parents d8920b2 + c26042d commit d578da5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
7 changes: 5 additions & 2 deletions .flake8
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
[flake8]
max-line-length = 88
max-complexity = 10
# These checks violate PEP8 so let's ignore them
extend-ignore = E203
extend-ignore =
# E203: Whitespace before ':' (violates PEP8 and black style)
E203,
# A005: A module is shadowing a Python builtin module
A005,
extend-exclude = */site-packages/*
13 changes: 5 additions & 8 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
build:
os: 'ubuntu-lts-latest'
tools:
python: '3.11'

sphinx:
fail_on_warning: true

# Optionally set the version of Python and requirements required to build your docs
python:
version: '3.8'
install:
- requirements: docs/requirements.txt
10 changes: 10 additions & 0 deletions docs/users/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ assert formatted == '```python\n"""black converts quotes"""\n```\n'
<td><code>go</code></td>
<td>Requires <a href="https://golang.org/doc/install">Go</a> installation</td>
</tr>
<tr>
<td><a href="https://github.com/Freed-Wu/mdformat-ruff">mdformat-ruff</a></td>
<td><code>python</code></td>
<td></td>
</tr>
<tr>
<td><a href="https://github.com/hukkin/mdformat-rustfmt">mdformat-rustfmt</a></td>
<td><code>rust</code></td>
Expand Down Expand Up @@ -118,6 +123,11 @@ formatted = mdformat.text(unformatted, extensions={"tables"})
<td><code>gfm</code></td>
<td>Changes target specification to GitHub Flavored Markdown (GFM)</td>
</tr>
<tr>
<td><a href="https://github.com/KyleKing/mdformat-gfm-alerts">mdformat-gfm-alerts</a></td>
<td><code>gfm_alerts</code></td>
<td>Extends GitHub Flavored Markdown (GFM) with "Alerts"</td>
</tr>
<tr>
<td><a href="https://github.com/KyleKing/mdformat-mkdocs">mdformat-mkdocs</a></td>
<td><code>mkdocs</code></td>
Expand Down

0 comments on commit d578da5

Please sign in to comment.