mirror of
https://github.com/Hopiu/wagtail.git
synced 2026-03-30 04:40:40 +00:00
78b1372cd4
Conflicts: docs/advanced_topics/i18n/index.rst docs/advanced_topics/settings.rst docs/getting_started/integrating_into_django.rst gulpfile.js/config.js wagtail/admin/tests/test_collections_views.py wagtail/api/v2/signal_handlers.py wagtail/contrib/wagtailstyleguide/views.py wagtail/core/tests/test_collection_permission_policies.py wagtail/documents/permissions.py wagtail/documents/tests/test_admin_views.py wagtail/documents/tests/test_collection_privacy.py wagtail/documents/tests/test_models.py wagtail/documents/views/chooser.py wagtail/documents/views/documents.py wagtail/documents/views/serve.py wagtail/documents/wagtail_hooks.py wagtail/documents/widgets.py wagtail/project_template/project_name/urls.py wagtail/tests/demosite/models.py wagtail/tests/non_root_urls.py wagtail/tests/settings.py wagtail/tests/testapp/models.py wagtail/tests/urls.py |
||
|---|---|---|
| .. | ||
| _static/images | ||
| advanced_topics | ||
| contributing | ||
| editor_manual | ||
| getting_started | ||
| reference | ||
| releases | ||
| topics | ||
| autobuild.sh | ||
| conf.py | ||
| index.rst | ||
| logo.png | ||
| Makefile | ||
| README.md | ||
| readthedocs.yml | ||
| requirements.txt | ||
| spelling_wordlist.txt | ||
| support.rst | ||
Wagtail docs
These are Sphinx docs, automatically built at http://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.