0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-24 19:17:48 +01:00
Commit Graph

57 Commits

Author SHA1 Message Date
Nathanaël Jourdane
5a8c33f34a doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
Chris Shenton
d1c020cd5f Fix Page.copy ref; silence warnings due to Sphinx missing support for type hints
Builds upon HimanshuGarg47:fix/11972-documentation-build-with-errors
2024-07-18 23:15:58 +01:00
Himanshu Garg
9adf742580 fixes errors by adding aliases, double backtick, changing indexentry 2024-07-18 23:15:40 +01:00
Himanshu Garg
e02ca6ce62 fixes some of errors by removing directives 2024-07-18 23:13:26 +01:00
Neeraj P Yetheendran
ecc1194f61 Add myst_url_schemes config for external links 2024-01-21 10:09:21 +10:00
Thibaud Colas
8a6ab175fc
Mention the BSD license in the docs copyright notice. Fix #9688 2023-12-22 06:37:34 +00:00
zerolab
ac10b36c7b Run pyupgrade with --py38-plus 2023-07-14 13:06:41 +01:00
LB Johnston
fb2c7760a5 Documentation - update package versions
- Upgrade Wagtail sphinx theme to 5.3.2
- Upgrade MyST parser to 0.18.1
- add sphinx_copybutton
- https://github.com/wagtail/sphinx_wagtail_theme/blob/main/CHANGELOG.md#531---2022-10-13
- https://github.com/wagtail/sphinx_wagtail_theme/blob/main/CHANGELOG.md#532---2022-10-16
2022-10-17 10:07:44 +01:00
Jake Howard
fbcdf89bc3 Add a security.txt file
https://securitytxt.org/
2022-09-06 08:09:30 +10:00
Dolidodzik
b131b4813e replace latin abbreviations with english phrases & updated docs guidelines
- added sub-section to language part of general_guidelines.md
- fixes #8860
2022-07-20 16:11:38 +10:00
LB Johnston
d9981e0ec7 fix up spelling in documentation & docstrings (should be en-GB not en-US)
- customize -> customise
- color -> colour
- customizing -> customising
- organize -> organise
2022-05-13 08:13:06 +10:00
Coen van der Kamp
7edb577d94 Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
Karl Hobley
0fd99886a2 Move tests to test 2022-03-17 17:19:59 +00:00
LB (Ben Johnston)
6ed65f14c6
Move Markdown docs to MyST parser. Fix #8074 (#8084) 2022-03-09 11:48:19 +00:00
Dan Braghis
d10f15e558 Reformat with black 2022-02-15 13:06:17 +00:00
Mads Jensen
de3fcba9e9 Fix warnings from flake8-comprehensions. 2022-02-11 14:34:00 +00:00
Thibaud Colas
046685149a
Add new version fo Wagtail Space docs banner. Fix #6089 (#7956)
* Add new version fo Wagtail Space docs banner. Fix #6089

* Fix closing date

Co-authored-by: Matt Westcott <matthew@torchbox.com>
2022-02-11 12:38:22 +00:00
Coen van der Kamp
ed4ed7a338
Add Sphinx Wagtail Theme (#6930)
Add Sphinx Wagtail Theme
2021-04-20 11:24:17 +02:00
Matt Westcott
cc9310220a Fix documentation build warnings 2021-04-15 17:17:11 +01:00
Tibor Leupold
328e7012fc
Switch documentation search to Algolia DocSearch (#6833)
Co-authored-by: Scott Cranfill <scott@scottcranfill.com>
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
Co-authored-by: Andy Chosak <andy@chosak.org>
2021-03-08 11:51:06 +00:00
Naomi I. Morduch Toubman
664b0489fe
Change master to main (#6830)
* Update references to `master` branch to say `main`

* Update external links

* Update links in old release notes
  Use tagged versions of code rather than current code
2021-03-03 13:33:19 -05:00
Thibaud Colas
0dbd69f491
Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +00:00
Matt Westcott
cbf0be31d5 revert to @allcaps's original approach to including robots.txt 2020-12-04 13:30:55 +00:00
Matt Westcott
7f4c914e68 try a different approach for including custom robots.txt 2020-12-02 11:13:23 +00:00
Coen van der Kamp
4702b6f14d Add custom robots.txt to docs 2020-11-12 16:35:05 +00:00
Matt Westcott
9947b955da Lint config fixes (#6473)
Ref #6463, #6428

* pin isort to 5.6.4
* update isort version mentioned in python_guidelines.rst
* make lint commands consistent between make lint and circleci
* fix isort errors on files outside of /wagtail
* speed up isort by ignoring additional directories and filetypes
2020-10-19 21:33:10 +01:00
Matt Westcott
906380486d isort new files added in #6428 2020-10-13 14:19:07 +01:00
Karl Hobley
f2dfff8061 Flake8 all other Python files 2020-10-05 14:27:50 +01:00
Karl Hobley
aafb5fb1eb Change docs code block style to 'default' 2020-10-05 11:21:07 +01:00
LB (Ben Johnston)
9359b14326
fix sphinx warnings (#6001)
- use .add_css_file instead of .add_stylesheet in conf.py
- use .add_js_file instead of .add_javascript in conf.py
- fix duplicate clss references in pages model reference (for grouping of methods & attributes)
- rename wagtailspace.js to banner.js (may be used in the future for a generic banner)
2020-05-03 14:02:43 +02:00
Coen van der Kamp
a26a3309ee Add Wagtail Space Arnhem banner to documentation 2019-01-24 11:28:56 +00:00
Sergey Fedoseev
29c8ad6637 Fix reference in ModelAdmin.ordering docs. 2018-10-30 12:23:17 +00:00
Benjamin Bach
a671f19298 Use current year for the copyright notice 2018-10-25 18:14:36 +01:00
Bertrand Bordage
06227a11ea Removes the temporary Kickstarter banner. 2018-04-16 17:16:05 +02:00
Bertrand Bordage
011a88fb07 Adds a temporary docs banner to the Kickstarter project. 2018-03-22 10:12:48 +00:00
Andy Chosak
e2f2a8c005 add favicon to documentation
This change copies the Wagtail admin favicon.ico (from
wagtail/admin/static_src/wagtailadmin/images) into the Sphinx build
directory so that built docs use the same favicon as the admin.

Makes use of [the Sphinx `html_favicon` setting](http://www.sphinx-doc.org/en/1.5.1/config.html#confval-html_favicon)
which adds this line to the generated HTML:

```html
<link rel="shortcut icon" href="_static/favicon.ico"/>
```

Fixes #4340.
2018-03-08 12:24:13 +00:00
LB
d6da38892a add wagtail colours to docs sidebar 2018-01-05 14:51:05 +10:00
Tim Heap
75e58efab8 Move version from wagtail.wagtailcore to wagtail
This is where developers expect it to be, similar to Django and other
projects. The version info still exists at the old `wagtail.wagtailcore`
location, for backwards compatibility.

Fixes #2557
2016-08-18 12:05:33 +01:00
Tim Heap
948cc5190d Use new VERSION tuple to build docs version 2016-08-18 12:05:33 +01:00
Tim Heap
8ddd9ee537 Call django.setup() before making docs
Django 1.9 requires this line before importing any models. Autodoc
imported models to get their docstrings, causing errors in the build
process.

Fixes #2014.
2015-12-09 11:40:35 +00:00
Dave Cranwell
09af55dfbb added logo 2015-05-18 09:11:11 +01:00
Frank Wiles
312033ba4e Update docs copyright year 2015-04-25 13:01:58 -05:00
Karl Hobley
b744e953de Don't use spelling extension on read the docs 2015-04-22 17:39:23 +01:00
Karl Hobley
7d6b039239 Use GB English for spellchecking 2015-04-19 10:24:12 +01:00
Karl Hobley
27facef89e Added spellcheker 2015-04-17 22:49:16 +01:00
Karl Hobley
1d7ca5a685 Made docs look at wagtailcore.__version__ 2014-09-09 12:56:26 +01:00
Matt Westcott
8edff405dd prepare for 0.5 release 2014-08-01 17:01:42 +01:00
Karl Hobley
6603c63b95 Use SQLite3 database backend when building docs
This prevents Django from loading psycopg2 when running autodocs on models files
2014-07-15 13:05:24 +01:00
Karl Hobley
4bfd0e5a20 Merge branch 'master' into autodoc
Conflicts:
	runtests.py
2014-07-11 12:23:25 +01:00
Matt Westcott
4f8cfa6346 version / date bump to 0.4 in changelog, setup.py and docs 2014-07-10 12:57:56 +01:00