0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Mitchel Cabuloy d0a0c804c2 Remove inappropriate banner landmarks & adopt main element in admin 404
According to the ARIA spec:

> A region that contains mostly site-oriented content, rather than page-specific content.

> Site-oriented content typically includes things such as the logo or identity of the site sponsor, and a site-specific search tool. A banner usually appears at the top of the page and typically spans the full width.

Where the `banner` role was applied was more page-specific than
site-specific. In addition, tags with `banner` roles should not live
under another landmark. To rectify, removed the misused banner roles.

Remove inappropriate contentinfo landmarks

According to ARIA spec 1.1

> A large perceivable region that contains information about the parent document.

> Examples of information included in this region of the page are copyrights and links to privacy statements.

They don't apply to the action buttons on where this was applied to.

Add main landmark to 404 page
2020-04-19 22:23:21 +10:00
..
_static Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
advanced_topics Add tutorials Q1 2020 2020-04-18 23:49:10 +01:00
contributing Mention docker-wagtail-develop in developing docs (#5820) 2020-02-12 14:11:40 +01:00
editor_manual Author specific locking docs changes (#5771) 2020-01-28 09:07:01 +00:00
getting_started Remove support for Django 2.1 (#5840) 2020-02-18 13:55:53 +00:00
reference Update BaseSetting to make it easier to utilise QuerySet.select_related() for more complex settings which reference related objects (such as pages) 2020-04-03 22:01:08 +01:00
releases Remove inappropriate banner landmarks & adopt main element in admin 404 2020-04-19 22:23:21 +10:00
topics Remove remaining references to request.site 2020-02-17 12:06:19 +00:00
autobuild.sh
conf.py Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Fix broken link to bakerydemo (#4834) 2018-10-21 11:38:28 +02:00
logo.png
Makefile Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
requirements.txt readthedocs needs a requirements.txt, apparently 2017-10-09 19:45:07 +01:00
spelling_wordlist.txt Added more words to the spelling wordlist 2018-04-05 12:13:05 +01:00
support.rst Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

To build the documentation for browsing, from this directory run:

make html 

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.