centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity
1,696 Commits 21 Branches 61 Tags
2a06ece80aa2e2c9aade9d596e7672763bf06044
Commit Graph

1696 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Oleh Prypin
2a06ece80a Synchronize requirements files, reduce deps installation for lint (#2943) 2022-08-21 17:15:46 +02:00
Oleh Prypin
edb646621c Fix event name typo in diagram 2022-08-21 17:12:35 +02:00
Oleh Prypin
a4f7298f8f Misc type fixes according to mypy 2022-08-20 22:12:43 +02:00
Oleh Prypin
fb5be39ee3 Misc type fixes according to mypy (#2940) 2022-08-20 20:45:08 +02:00
Timothée Mazzucotelli
b1c140c6ca Add a link to best-of-mkdocs in the readme (#2824) 2022-08-19 23:19:52 +02:00
Oleh Prypin
9c0a8e50b1 Move some documentation into code, add misc API docs page (#2934) 2022-08-17 18:07:10 +02:00
Oleh Prypin
6b8b5e861b Revert to the explicit way of registering plugins' methods (#2937) 
See prior: f79b34d174 (diff-da2086192f0b49a8ae9a67eba6ec5e7572aaa0c0db458b1d9deea21005fc7655L84)

But now we need to also skip non-overridden methods. That's also the reason why I needed to use `staticmethod`, so these are not concealed by `bound method` functionality.
 2022-08-17 18:05:10 +02:00
Sylvain Marié
c5619dbade SubConfig: allow to actually validate the nested configs (#2807) 
Co-authored-by: Oleh Prypin <oleh@pryp.in>
 2022-08-17 18:03:15 +02:00
Oleh Prypin
7c44a09c03 Update gitignore 2022-08-15 23:37:14 +02:00
Oleh Prypin
ca9c8c1a60 Allow an empty repo_url when still specifying a edit_uri (#2928) 2022-08-15 18:54:26 +02:00
Oleh Prypin
54db3df2e7 Fix deprecated field in setuptools (#2933) 
> The license_file parameter is deprecated, use license_files instead.
 2022-08-15 17:36:48 +02:00
Oleh Prypin
82a8b2fc02 Merge pull request #2930 from oprypin/slash 
Refactor URI handling to not have to deal with backslashes
 2022-08-15 16:45:29 +02:00
Oleh Prypin
7837d351c7 Add warnings about \ for create_media_urls and normalize_url 2022-08-15 16:28:08 +02:00
Oleh Prypin
0b58cce84d Cache src_uris 2022-08-15 16:25:54 +02:00
Oleh Prypin
1c50987f9c Refactor URI handling to not have to deal with backslashes 2022-08-15 16:25:52 +02:00
Oleh Prypin
70f39d4f63 Merge pull request #2931 from mkdocs/docplug 
Refactor plugin events, move docs to source code, type annotations
 2022-08-15 13:04:32 +02:00
Oleh Prypin
12841f1aa5 Add type annotations for plugin events, include them in the docs 2022-08-14 18:33:36 +02:00
Oleh Prypin
f79b34d174 Move plugin events docs into source code + refactor 
* Create real (no-op) methods for each event in the base class.
* Refactor event dispatcher to not check for methods' existence, instead just call them.
* Move documentation from Markdown into docstrings of these methods.
* Activate the 'mkdocstrings' plugin.
* Use 'mkdocstrings' to insert documentation from those docstrings into the site.
 2022-08-14 18:33:36 +02:00
Oleh Prypin
5b87ba9971 Drop py36 integration tests 2022-08-14 18:21:10 +02:00
Oleh Prypin
f772a30534 Refactor tests to use subTest (#2929) 
This allows finding which of the cases failed, otherwise the error just points to the line number.
 2022-08-13 19:03:13 +02:00
Oleh Prypin
0c1e8c1f6e Bugfix for commit "Deduplicate test_nested_page_edit_url" 2022-08-13 17:33:44 +02:00
Oleh Prypin
6e3ee0e753 Deduplicate test_nested_page_edit_url 2022-08-13 14:09:48 +02:00
Oleh Prypin
af8342e90b Enable "Edit on GitHub" for own site 2022-08-13 12:18:49 +02:00
Oleh Prypin
c7111b2cee Fix and refactor a convoluted test (#2921) 
Everything after an `and` was never run because `None and anything` short-circuits to `None`.
And if it *did* run, it would've failed
 2022-08-10 08:37:01 +02:00
Oleh Prypin
0437b7f853 Merge pull request #2918 from oprypin/isort 
Re-format code with `isort` and enforce it
 2022-08-09 17:38:06 +02:00
Oleh Prypin
a66a7ba474 Enforce 'isort' formatter 2022-08-08 21:42:39 +02:00
Oleh Prypin
d6375e5413 Re-format code with isort 2022-08-08 21:42:39 +02:00
Oleh Prypin
bb91bcd76d Rework SubConfig so it doesn't share mutable state (#2916) 2022-08-08 19:30:08 +02:00
Oleh Prypin
98672b85f6 Fix for lingering mdx_configs across separate Config instances (#2290) 2022-08-08 19:21:17 +02:00
Oleh Prypin
d6bfb1bc6f Merge pull request #2913 from oprypin/black 
Re-format code with `black -l100` and enforce it
 2022-08-08 18:54:58 +02:00
Oleh Prypin
de5436fbc8 Stop checking diffs in translation files in CI (#2917) 
This check has only caused a lot of spurious failures. I never check it.
 2022-08-08 18:50:28 +02:00
Oleh Prypin
58a99e5b38 Enforce Black formatter 2022-08-07 20:25:35 +02:00
Oleh Prypin
dca7cbb43f Format code with black -l100 --skip-string-normalization 2022-08-07 20:25:34 +02:00
Oleh Prypin
372384d810 Some manual changes ahead of formatting code with Black 2022-08-07 20:24:21 +02:00
Oleh Prypin
e7f07cc82a Remove spaces at the ends of docstrings, normalize quotes 2022-08-07 15:32:35 +02:00
Oleh Prypin
b2fb1b7458 Simplify utils, deprecate unused functions (#2912) 
For `is_markdown_file` instead do a breaking change so it matches the actual behavior of MkDocs build: don't accept uppercase extensions anymore.
 2022-08-07 15:32:16 +02:00
Oleh Prypin
f5777a915a Docs: add a diagram with relations between all the plugin events (#2387) 2022-08-07 15:05:44 +02:00
Oleh Prypin
6f3801cbd3 Lint: align the whole list item into 4 spaces, don't disregard 1st line (#2915) 
In other cases, drop the multiline way of writing the list
 2022-08-07 14:57:06 +02:00
Oleh Prypin
cd1135ee3e Fix remaining markdownlint issues, partly by replacing definition lists (#2914) 2022-08-07 14:46:10 +02:00
Oleh Prypin
c04dc81039 Fix a Python lint error 2022-08-06 17:40:54 +02:00
Oleh Prypin
22af92c874 Migrate docs from "admonition" to "callouts" extension (#2684) 
The result is exactly equivalent, just different syntax -- one that doesn't look weird in vanilla Markdown parsers such as on GitHub.
The output HTML before/after is equivalent , other than adding `<p class="admonition-title">Block</p>` in two cases, which I hid with CSS.

This also contributes to fixing the currently-present markdownlint MD053 violations, as it can't scan inside admonitions.

Add 'markdown-callouts' to dependencies and bump Markdown dep.
 2022-08-06 17:35:36 +02:00
Tim Gates
a1a2da72e9 Fix a few typos in docs (#2897) 
There are small typos in:
- docs/user-guide/writing-your-docs.md
- mkdocs/contrib/search/templates/search/lunr.js
- mkdocs/utils/meta.py

Fixes:
- Should read `delimiters` rather than `deliminators`.
- Should read `environments` rather than `enviroments`
 2022-08-03 18:54:09 +02:00
Oleh Prypin
3ffe21df91 Show DeprecationWarnings as INFO messages (#2907) 
(previously they were not shown at all)

This works for both extensions and plugins -- and for MkDocs itself.
It will enable plugin developers to see warnings in advance. Or users to report such warnings to plugin developers.
 2022-08-01 20:45:04 +02:00
Oleh Prypin
a17a25c60e Release 1.3.1 (#2895) 1.3.1 2022-07-19 09:23:14 +02:00
Ultrabug
dd7986ff7b Requirements: pin Markdown version to <3.4 (#2893) 2022-07-19 09:09:11 +02:00
Oleh Prypin
6bd62b9738 When a Markdown extension fails to load, print its name and traceback (#2894) 2022-07-19 08:50:18 +02:00
Francesco Maida
d93feffadd Italian translation for mkdocs and readthedocs themes (#2860) 2022-07-19 08:14:10 +02:00
Simon Li
03b48936e3 Docs: site_url is optional (#2863) 2022-07-18 23:49:23 +02:00
Carlos Meza
042d7c25ac Check only for uppercase README.md file (#2852) 2022-07-18 23:16:06 +02:00
Sean
82bd8ba5ff Clean up code style (#2825) 
* Change Github to GitHub
* Add space before closing tag
* Convert tabs to spaces
* Fix coding style for some css
 2022-05-18 00:22:08 +02:00