Commit Graph

11 Commits

Author SHA1 Message Date
Oleh Prypin
901f6ffa1d Fixup for API docs: these toc entries were not intended 2022-08-21 19:44:53 +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
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
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
Ultrabug
ba7f63ac81 dev guide: remove misleading usage of 'entry_point' wording (#2563)
closes mkdocs/mkdocs#2558 thx to @hwittenborn
2021-09-08 08:48:47 +02:00
Kuba Andrýsek
98b1d0e991 Fix Jinja Environment link (#2552) 2021-08-23 18:25:22 +02:00
Oleh Prypin
b12804d97e Fix some spelling typos (#2489) 2021-07-13 19:07:59 +02:00
Waylan Limberg
769a926691 Correct documentation of on_pre_template event.
The behavior of this event has never changed. The documentation was simply
incorrect. Fixes #2308.
2021-06-02 13:01:21 -04:00
Waylan Limberg
a118183f5e Refactor docs (#2344)
The homepage has been redesigned. The "Installation" and "Getting Started" sections were moved to their own respective pages. Then, the homepage was restyled so that the list of features appear as a grid of cards.

The developer specific pages were moved to a new section: `dev-guide`. Any old URLs redirect to the new ones.
2021-04-04 16:14:29 -04:00