mirror
/
wagtail
kopia lustrzana https://github.com/wagtail/wagtail
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
18 137 Commity
55 Gałęzie
258 Tagi
445 MiB
Wykres commitów

32 Commity (37567dfe1844d39784793942fb8cdbaae6ba6ef0)

Autor SHA1 Wiadomość Data
Sage Abdullah 794fa3bcaf
Improve documentation guidelines on writing docstrings and API reference 2024-11-05 12:52:57 +00:00
Sage Abdullah a81cc7345d
Remove e.g. in documentation guidelines 2024-11-05 12:45:26 +00:00
Sage Abdullah da3e0ade37
Use intersphinx to link to MyST-Parser docs 2024-11-05 10:44:41 +00:00
Sage Abdullah 9d69863f3c
Use intersphinx to link to Sphinx docs 2024-11-05 10:44:39 +00:00
Sage Abdullah 795ca50dc8
Improve clarity between Markdown/MyST, rST, and Sphinx in docs guidelines 
Add more emphasis on the divide between when to use Markdown and when to
use rST.

Also improve examples for versionadded and versionchanged directives.
 2024-11-05 10:44:39 +00:00
Sage Abdullah 0dc1698857
Do not index autodoc examples 2024-11-05 10:44:39 +00:00
Sage Abdullah 443ccb23a8
Update docs for writing admonitions 
It's MyST syntax, not rST, so it's OK to use it (sparingly).

Custom admonitions are possible with the `admonition` directive.
 2024-11-05 10:44:38 +00:00
Sage Abdullah 81e6d79c5e
Improve guidelines for writing links in docs 2024-11-05 10:44:38 +00:00
Sage Abdullah dddf9bfd81
Highlight Markdown vs reStructuredText differences for inline styles 2024-11-05 10:24:51 +00:00
Sage Abdullah 121624d5b1
Add syntax highlighting to code block examples 2024-11-05 10:24:51 +00:00
Aayushman Singh e28beb5b45 Docs - Writing guidelines - Add code example considerations 
Start a small section to offer some guidance to ensure that code examples are secure, accessible and easier to use.
 2024-11-02 10:29:19 +10:00
Sage Abdullah 3802f8bf46 Fix remaining XHTML errors in docs to remove ePub build errors 
Had to remove the <details> element for the section linking example in
the "Reference links" section.

This is because Sphinx/MyST renders a <section> element for each heading
and closes it when the next heading starts. If we create a heading
inside a <details> element, the <section> element will not be closed
until the next heading starts, which generates invalid HTML.
 2024-10-31 07:52:49 +10:00
Matt Westcott 4d31bd0a29 Add clarification on using versionadded / versionchanged directives 2024-10-22 22:13:36 +01:00
EK303 bd065c17cd Docs - Update and fix broken links 
Fixes #11635
 2024-02-16 17:23:53 +10:00
Victoria Poromon c4f953e90f
Changed all British spellings to American spellings, in the Contributing to wagtail section. (#11641) 
* Changed all British spellings to American spellings, in the Contributing to wagtail section
 2024-02-14 08:20:02 +10:00
LB Johnston bbcf1e74ee Add changelog & a few fixes for #11194 
Partially reverts commit 7fa335c20d (fixing some issues with the URL updates)
 2024-01-21 18:55:43 +10:00
LB Johnston 24725fe681 Add documentation guidelines section for external (Django) links 2024-01-21 10:09:21 +10:00
Damilola Oladele 1c0ffc8994
Document new choice of writing style guide (#10634) 2023-10-06 23:24:26 +01:00
Thibaud Colas 42f5ea1fc8 Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
LB Johnston 28013470a7 Documentation - clean up white space 2022-10-27 07:18:22 +10:00
Albina 1434a93c54
Improve grammar, spelling, and punctuation in Contributing to Wagtail section (#9396) 
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
 2022-10-19 21:51:16 +01:00
Ruqouyyah Muhammad 398c575153
Add missing rendered output in documentation guidelines. Fix #9331 (#9365) 
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
 2022-10-16 01:12:57 +01:00
LB (Ben Johnston) 18371e2113
Documentation - adopt consistent `sh` console code snippets (#9321) 2022-10-13 07:25:19 +01:00
LB Johnston 75b64f70b5 Remove unused `note` title from page inline panel docs 
- add clarity to the docs that `admonition` is also not to be used
- title for this note is not required
- fixes #9125
 2022-09-06 19:28:47 +10:00
LB Johnston 666cc5e8e5 fix up legacy release note refs & use consistent format 
- fix some broken refs that were lost in the migration to markdown files
- use lower_snake_case for all internal refs (most follow this convention)
- release process sub-section in docs should be named release schedule instead
 2022-08-16 12:42:42 +01:00
Karl Hobley 75cc7da38a Move wagtail.core to wagtail 2022-03-17 17:19:59 +00:00
Karl Hobley da04f1e50b Move core.utils to core.coreutils 2022-03-17 17:19:59 +00:00
LB Johnston 6439b1e8a5 refine documentation guidelines for links 
- add clarity that page links can also get auto-generated labels
- add example of a reference link using a custom label
- format with prettier
 2022-03-16 20:51:58 +10:00
Thibaud Colas c5aa326565 Switch to Markdown tables for documentation 2022-03-11 15:21:47 +00:00
LB (Ben Johnston) 6ed65f14c6
Move Markdown docs to MyST parser. Fix #8074 (#8084) 2022-03-09 11:48:19 +00:00
Matt Westcott bdfa3811d1 Remove outdated versionadded/versionchanged annotations 2021-07-13 17:10:56 +01:00
Thibaud Colas 29942d2a48
Add documentation formatting reference (#6729) 
Co-authored-by: Andy Chosak <andy@chosak.org>
Co-authored-by: Tom Dyson <tom@torchbox.com>
 2021-01-29 10:38:47 +00:00