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
2,003 Commits 21 Branches 61 Tags
df2dffd8a62f312e98987998af3114f3e1e552fb
Commit Graph

2003 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Oleh Prypin
df2dffd8a6 New flag serve --open to open the site in a browser (#3500) 
After the first build is finished, the default webbrowser will open the home page of the site.
 2023-12-03 22:00:13 +01:00
Oleh Prypin
8035d78dad Refactor serve URL handling, pass only the URL to build (#3501) 
Co-authored-by: Philipp Temminghoff <philipptemminghoff@googlemail.com>
 2023-12-03 21:59:46 +01:00
Oleh Prypin
646987da45 Merge pull request #3465 from mkdocs/secu 
Stop executing YAML tags for mkdocs_theme.yml, warn about third-party projects
 2023-11-21 21:46:31 +01:00
Oleh Prypin
eaf4e4f4c3 Merge pull request #3464 from mkdocs/rtnav 
Fix readthedocs theme expanding all top level ToC entries
 2023-11-21 21:10:44 +01:00
Oleh Prypin
47e41a9a0e Still use the fast version of SafeLoader 2023-11-21 21:08:28 +01:00
Oleh Prypin
35fb2c7203 Move code to external mkdocs-get-deps dependency (#3477) 
The "get-deps" command will still be provided inside MkDocs like before (and is not deprecated at all) but is now implemented in a separate repository and can be used directly from there as well.

This separation of code was done because obtaining just the "get-deps" part with very few dependencies can be useful: one can run it in a main environment but then install actual MkDocs with dependencies in a virtual environment.
 2023-11-21 21:03:41 +01:00
Oleh Prypin
8aafea1742 Fix overzealous validation of !relative tag (#3466) 
If a Markdown extension immediately resolves the path inside its initialization (rather than just storing it for later as I was hoping) then it was failing the initial validation run that MkDocs does without populating an actual page yet.
 2023-11-14 18:35:30 +01:00
Oleh Prypin
c3c980582f Cache the result of the function get_themes() 2023-11-11 16:50:49 +01:00
Oleh Prypin
9ff9bb10bf Docs: warn about installing third-party plugins 2023-11-11 16:50:48 +01:00
Oleh Prypin
9e67e466f8 Stop allowing arbitrary YAML tags for mkdocs_theme.yml 2023-11-11 16:50:48 +01:00
Oleh Prypin
da35dcad0c Support mkdocs-section-index plugin in readthedocs theme 
-Handle the case when something is both a page and a section
 2023-11-11 16:18:12 +01:00
Oleh Prypin
575a19a5f4 Fix readthedocs theme expanding all top level ToC entries 2023-11-11 16:17:36 +01:00
Oleh Prypin
dc45916aa1 Allow adding event handlers at multiple priorities (#3448) 
-within one plugin.
 2023-11-08 18:33:38 +01:00
Oleh Prypin
0a4f3240d1 Use projects' own type annotations, stubs no longer needed 2023-11-02 00:02:29 +01:00
Vedran Miletić
0bf4963090 Quote pip arguments containing square brackets (#3456) 
This is strictly necessary when using non-bash shells (e.g. tcsh).
 2023-11-01 17:20:14 +01:00
Oleh Prypin
9455b079d8 Stop suppressing OSError indiscriminately during build (#3445) 
This was aimed at user-facing "file not found" errors from "serve" but it can catch errors from plugins as well, and it only makes the errors very confusing.
 2023-10-31 09:49:12 +01:00
Oleh Prypin
8909ab3f6d Reduce logs for invalid links if referring page is excluded (#3449) 
* If source page and destination page is excluded, cap log level to DEBUG
* If source page is excluded, cap log level to INFO

Co-authored-by: Chris Mayfield <mayfiecs@jmu.edu>
 2023-10-30 02:04:50 +01:00
Oleh Prypin
7ab01c24ff Add an enabled setting for all plugins (#3395) 
For every plugin, the user can set `enabled: false` (or something based on an environment variable) and it will not kick in at all.

If the plugin has its own `enabled` config, there's no change for it in that case.
 2023-10-30 01:58:27 +01:00
Oleh Prypin
f3d5c8dc8d Refactor File tests 2023-10-30 00:56:24 +01:00
Oleh Prypin
3a69c9a6dd Merge pull request #3443 from mkdocs/innav 
Apply planned changes to `File.page` and `not_in_nav`
 2023-10-30 00:56:09 +01:00
Oleh Prypin
ae93314b9a In verbose log, report each plugin's events individually (#3444) 2023-10-29 18:40:36 +01:00
Oleh Prypin
994ffff114 Clean up unused args in tests 2023-10-29 12:13:56 +01:00
Oleh Prypin
f31caca339 mypy: Stop ignoring missing imports 2023-10-29 10:49:15 +01:00
Oleh Prypin
d107e6d32c When nav config is not specified, apply file inclusion 
to decide whether a file in included when generating the implicit nav.

Fixes #3336
 2023-10-28 17:40:15 +02:00
Oleh Prypin
a94a014e01 Error when setting File.page to a type other than Page 
As per the prior plan https://github.com/mkdocs/mkdocs/pull/3381#issuecomment-1712750515
 2023-10-28 17:38:42 +02:00
Oleh Prypin
b5250bf9e2 Stop config validation after the first error (#3437) 
If one config option completely fails validation, that means its value remains "raw" from YAML, which can cause unpredictable errors when validating other options that might look at the value. Instead just decide one error is enough.
 2023-10-25 19:41:00 +02:00
sumebrius
49d02e48ed Add fallback git link for non-provider repos (#3435) 2023-10-25 19:40:42 +02:00
Oleh Prypin
3e0949a332 Merge pull request #3430 from mkdocs/ruffdocs 
Apply more rules from ruff, esp. for docstrings
 2023-10-20 15:31:30 +02:00
Oleh Prypin
3c9d0765ea Merge pull request #3429 from mkdocs/py37 
Drop Python 3.7, officially support Python 3.12
 2023-10-20 15:30:40 +02:00
Oleh Prypin
125f36f943 Enable more ruff rules 2023-10-16 22:42:10 +02:00
Oleh Prypin
4710d73999 Apply rules to docstrings 2023-10-16 22:41:10 +02:00
Oleh Prypin
0d8d1f2b4d Use features new to Python 3.8, apply positional-only args 
(the latter constitutes a breaking change for MkDocs, but nobody should be relying on these as named args)
 2023-10-16 22:39:14 +02:00
Oleh Prypin
e2a9576b24 Drop Python 3.7, officially support Python 3.12 2023-10-16 22:39:14 +02:00
Oleh Prypin
828f4685f2 Fix unittest invocation on Windows, don't apply coverage by default 
-Tests actually weren't being run on Windows!
 2023-10-16 22:32:28 +02:00
Oleh Prypin
cc76672d55 Workaround: babel depends on setuptools without declaring it 
https://github.com/python-babel/babel/issues/1031
 2023-10-16 22:32:28 +02:00
Oleh Prypin
ad73366e52 Fix tests on Windows 2023-10-16 22:32:28 +02:00
Oleh Prypin
b3992222b1 Move forward with some deprecations (#3425) 2023-10-16 22:32:08 +02:00
Oleh Prypin
44e6536060 Update CI to be consistent with deploy-release.yml 2023-10-14 13:35:26 +02:00
Oleh Prypin
79ae55e0cb Fix typo 2023-10-14 12:45:02 +02:00
Martin Donath
a6fef567bf Improve editing experience when using --livereload (#3391) 
The livereload server connection is cancelled when the tab becomes inactive.
Once a tab becomes active, the livereload connection is immediately established again.
 2023-10-14 12:27:16 +02:00
Oleh Prypin
00b648f088 Release 1.5.3 (#3392) 1.5.3 2023-09-18 23:23:33 +02:00
Oleh Prypin
63b50450fb Change PyPI deploy to rely on "trusted publishers" (#3400) 2023-09-18 18:13:47 +02:00
Oleh Prypin
abb133fbb1 Fix new lint warnings 2023-09-18 17:52:05 +02:00
Martin Donath
8c79426844 Abort livereload request before navigation (#3390) 2023-09-14 20:41:53 +02:00
Peter Dave Hello
f94ab3f62d Add zh_TW locale for built-in themes (#3370) 2023-09-13 18:21:59 +02:00
Oleh Prypin
0d6fc286fa Merge pull request #3383 from mkdocs/breadcrumbs 
Fix breadcrumb display in readthedocs theme
 2023-09-13 18:21:00 +02:00
Oleh Prypin
4bd896c8f2 Fix linkified breadcrumb items in readthedocs theme 
A doc can never have a `link` attribute so this branch never kicked in.

Actually even now, this branch will still not kick in, only mkdocs-section-index makes this state possible.
 2023-09-11 00:03:04 +02:00
Oleh Prypin
c070dd0202 Fix broken styling of breadcrumbs in readthedocs theme 
Commit 3c3670d92c left it half way between the old and new style
 2023-09-11 00:03:04 +02:00
Oleh Prypin
347c3a91dd Apply automatic fixes from ruff, show diff in CI 2023-09-11 00:02:51 +02:00
Oleh Prypin
759e1e3bae Keep the prior behavior of overwriting File.page (#3381) 
unless the page value is a *strict* subclass of Page
 2023-09-10 13:05:28 +02:00