8000 feat: add v4 docs to main branch (#7722) · django-cms/django-cms@737e86e · GitHub
[go: up one dir, main page]
Skip to content

Commit 737e86e

Browse files
fsbraunfsbraun
authored
feat: add v4 docs to main branch (#7722)
* Add docs * Improve formatting * Update formatting * Update changelog for 4.0 from git logs * Fix typos
1 parent 3411b98 commit 737e86e

File tree

137 files changed

+5981
-6187
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+5981
-6187
lines changed

‎CHANGELOG.rst

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,134 @@ With the review help of the following contributors:
105105

106106
Thanks to all contributors for their efforts!
107107

108+
4.0 (unreleased)
109+
================
110+
111+
Features:
112+
---------
113+
* Added pre-migrate hook to check version 4 is intentional (#7249) (ff6cb9b5d) -- Mark Walker
114+
* Add live-url url query parameter to PageContent cms Preview and Edit endpoints (#7359) (ee89fe4f4) -- Adam Murray
115+
* backport - Upgrade Gulp and Nodejs (#7255) (f110ddb25) -- Aiky30
116+
* Re-enable showing the toolbar to anonymous users (#7221) (2008ca8a8) -- Aiky30
117+
* backport - django-cms 4.0.x - Django 3.2 support (#7153) (b0deaedd7) -- Aiky30
118+
* backport - django-cms 4.0.x - Django 3.1 support (#7145) (fb0d4f235) -- Aiky30
119+
* backport - django-cms 4.0.x - Django 3.0 support (#7105) (c44b6beda) -- Aiky30
120+
* djangocms 4.0.x documentation updates (#7007) (#7130) (28f41fe9c) -- Aiky30
121+
* Split database packages so that tests can be run with sqlite (same changes as develop) (#7042) (c77b5e08a) -- Mark Walker
122+
* Back ported migrating from Travis.ci to Git 1241 hub actions from develop (#7006) (29ae26eaf) -- Aiky30
123+
* Add CMSAppExtension.ready which is called after all cms app configs are loaded (#6554) (c02308fc5) -- Krzysztof Socha
124+
* Deprecate the core Alias plugin (#6918) (0fec81224) -- Aiky30
125+
* Refactor get_title_cache to be straightforward and populate when only partially populated (#6829) (80911296b) -- Jonathan Sundqvist
126+
* Add Oracle support to custom plugin queries. (#6832) (90bb064fa) -- Jonathan Sundqvist
127+
* Provide a general get method that can be monkeypatched (#6806) (e429b4584) -- Jonathan Sundqvist
128+
* Adding support for Django 2.2 LTS to django-cms 4.0 (#6790) (1b80000cf) -- Jonathan Sundqvist
129+
* Optionally disable the sideframe (#6553) (a1ac04d3f) -- Aiky30
130+
* Dedicated edit preview buttons (#6528) (5005cd933) -- Malinda Perera
131+
* Use PageContent instance in wizard form instead of Page instance (#6532) (4307e1b8c) -- Krzysztof Socha
132+
* Expose sideframe in CMS.API (4dadf9f1e) -- Vadim Sikora
133+
* Add toolbar persist GET parameter (#6516) (fb27c34e2) -- Krzysztof Socha
134+
* Rename default persist param (a7df58dc5) -- Krzysztof Socha
135+
* Removed resolve view (e3a23a7fc) -- Paulo
136+
* Removed resolve page (0e885ca9e) -- Vadim Sikora
137+
* Add toolbar_persist GET parameter, defaulting to true. If set to false disabling/enabling toolbar won't be saving in the session (77a48d6ee) -- Krzysztof Socha
138+
* Added language to Page translation operations (ca16415b1) -- Paulo
139+
* Use get_title_obj on Page toolbar (#6508) (4981c6229) -- Krzysztof Socha
140+
* Add frontend editing & rendering registry (#6500) (db4ff4162) -- Krzysztof Socha
141+
* Added placeholder checks (#6505) (53171cf2b) -- Krzysztof Socha
142+
* Added language switcher to page tree + re-enabled tests (#6506) (70db27c49) -- Vadim Sikora
143+
* Added PageContent admin (#6503) (2e090d6c2) -- Paulo Alvarado
144+
* Integrated Placeholder source field (#6496) (b075f44d3) -- Malinda Perera
145+
* Added BaseToolbar.preview_mode_active property (#6499) (39562aeb9) -- Krzysztof Socha
146+
* Renamed Title model to PageContent (#6489) (2894ae8bc) -- Aiky30
147+
* Added warning for create_page published arg (f48b8698f) -- Paulo Alvarado
148+
* Fixed frontend to use new edit/structure urls (e960ce726) -- Vadim Sikora
149+
* Added Preview, Structure and Edit endpoints (#6490) (0f12156c8) -- Malinda Perera
150+
* Removed publisher from core (#6486) (9f2507545) -- Paulo Alvarado
151+
* Moved certain Page fields to Title model (#6477) (d7e2d26a6) -- Krzysztof Socha
152+
* Moved permission creation logic out of _create_user (cd74dc85d) -- Paulo Alvarado
153+
* Replaced custom app plugin endpoints with placeholder endpoints (#6469) (685361d47) -- Aiky30
154+
* Frontend for new plugin architecture (bda219b7f) -- Vadim Sikora
155+
* Removed default plugin creation for placeholders (#6468) (eef5cbbfe) -- Krzysztof Socha
156+
* Added MySQL and SQLite compatibility to plugin tree (#6461) (4dfaa1c36) -- Mateusz Kamycki
157+
* Added Placeholder admin plugin endpoints (#6465) (bf1af91bf) -- Aiky30
158+
* Refactored plugin tree (#6437) (83d38dbb2) -- Paulo Alvarado
159+
* Register Placeholder model with admin (#6458) (5a1c89316) -- Aiky30
160+
* Removed placeholder content fallbacks (#6456) (a9947fed1) -- Aiky30
161+
* Added Generic Foreign Key field to Placeholder model (#6452) (0aedfbbd1) -- anirbanlahiri-fidelity
162+
* Removed revert to live feature (#6454) (1d7894684) -- Aiky30
163+
* Removed publisher_publish management command (#6453) (cb19c6069) -- monikasulik
164+
* Removed publish / unpublish buttons from page changelist (#6445) (9905ca6ec) -- Aiky30
165+
* Introduced Django 2.0 & 2.1 support (#6447) (30f2d28cc) -- Paulo Alvarado
166+
* Removed logic which publishes the first page page as soon as it is created (#6446) (cf442f756) -- Aiky30
167+
* Removed unpublish button from toolbar (#6438) (14110d067) -- Aiky30
168+
* Moved placeholders from Page to Title model (#6442) (37082d074) -- Aiky30
169+
* Added app registration integration for wizards (#6436) (c8f56a969) -- monikasulik
170+
* Log all page and placeholder operations (#6419) (039415336) -- Aiky30
171+
* Added request to page create form (#6425) (61150ed91) -- Paulo Alvarado
172+
* Introduced app registration system (#6421) (97515c81d) -- monikasulik
173+
* Update apphooks.rst (#6255) (98380b5d7) -- Chematronix
174+
* Removed Publish button from the toolbar (#6414) (41c4ab0dc) -- Aiky30
175+
176+
Bug Fixes:
177+
----------
178+
* Structure mode toggle button disappearing from toolbar (#7272) (7dafe846a) -- Fabian Braun
179+
* Placeholder copy orphaned plugin children (#7065) (#7131) (39483cf32) -- Aiky30
180+
* Update support options in README.rst (#7059) (22395d7c5) -- Simon
181+
* Fix being able to reset the setting PageContent.limit_visibility_in_menu (#7016) (66c70394c) -- Aiky30
182+
* Patch defects (#6930) (d88932559) -- Adam Murray
183+
* Pagecontent template not changing when the UI option is changed (#6921) (68947484a) -- Aiky30
184+
* Replace deprecated Jquery .load() call with .on('load', (#6922) (c9cd9fbf2) -- Aiky30
185+
* Added missing softroot to the migration copy from Page to PageContent (#6888) (c8fbde737) -- Aiky30
186+
* Display the correct url in change_language_menu (#6828) (026ff1c86) -- Jonathan Sundqvist
187+
* Prevent JS injection in the admin add plugin url (#6885) (72025947d) -- Aiky30
188+
* Fix 'urls.W001' warning with custom apphook urls (#6874) (75978fb1c) -- Aiky30
189+
* Override urlconf_module so that Django system checks don't crash. (#6873) (f1226a57b) -- Aiky30
190+
* ``get_object`` call was missing request argument (#7302) (98959dc12) -- Mark Walker
191+
* page tree display and status alignment (#7263) (914558d28) -- Mark Walker
192+
* Removed bad migration character (#6834) (d6cabc49f) -- Aiky30
193+
* Remove exclude as no longer supported (#6830) (7aeacb045) -- Jonathan Sundqvist
194+
* Replaced incorrect model being saved when a foreign key to placeholder is remapped to use the generic foreign key (#6802) (5bfb1d144) -- Aiky30
195+
* Raise 404 on when page has no content (#6803) (8e7cdb12d) -- Jonathan Sundqvist
196+
* Fix add translation form, as AddPageForm expects cms_page parameter (#6534) (017a7e472) -- Krzysztof Socha
197+
* Fixed a bug with deleting a model from changelist inside modal (597488954) -- Vadim Sikora
198+
* Fix data validation (085ab6d13) -- Krzysztof Socha
199+
* Failing log entry tests (59441e5a5) -- Paulo
200+
* Broken migration (3c3bf884b) -- Paulo
201+
* Page list language switcher bugs (cfeb3a74c) -- Paulo
202+
* Missing permissions bug (ba60a1c3a) -- Paulo
203+
* Fixed a bug with expanding static placeholder by clicking on "Expand All" button (e0c940ce3) -- Vadim Sikora
204+
* Fixed a bug with not enabling plugins that are not rendered in content (dca32358a) -- Vadim Sikora
205+
206+
Statistics:
207+
-----------
208+
209+
This release includes 107 pull requests, and was created with the help of the following contributors (in alphabetical order):
210+
211+
* Aiky30 (35 pull requests)
212+
* Krzysztof Socha (17 pull requests)
213+
* Paulo Alvarado (12 pull requests)
214+
* Vadim Sikora (11 pull requests)
215+
* Jonathan Sundqvist (7 pull requests)
216+
* Mark Walker (6 pull requests)
217+
* Paulo (6 pull requests)
218+
* Malinda Perera (3 pull requests)
219+
* monikasulik (3 pull requests)
220+
* Adam Murray (2 pull requests)
221+
* Chematronix (1 pull request)
222+
* Fabian Braun (1 pull request)
223+
* Mateusz Kamycki (1 pull request)
224+
* Simon (1 pull request)
225+
* anirbanlahiri-fidelity (1 pull request)
226+
227+
228+
With the review help of the following contributors:
229+
230+
* Adam Murray
231+
* Aiky30
232+
* Angelo Dini
233+
* Krzysztof Socha
234+
235+
108236
3.6.0 (2019-01-29)
109237
==================
110238

‎docs/Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ html:
3737
. $(VENV); $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
3838
@echo
3939
@echo "Build finished. The HTML pages are in build/html."
40-
sphinx-build -b html -n -d build/doctrees -D latex_paper_size=a4 -D latex_paper_size=letter build/html
4140

4241
install:
4342
@echo "... setting up virtualenv"
@@ -117,3 +116,9 @@ spelling:
117116

118117
run:
119118
. $(VENV); sphinx-autobuild $(ALLSPHINXOPTS) build/html --host 0.0.0.0 --port $(PORT)
119+
120+
text:
121+
. $(VENV); $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) build/text
122+
@echo
123+
@echo "Build finished. The HTML pages are in build/text."
124+

‎docs/compatibility.include

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
=========== ==== ==== ==== === === === === === === === === === === === ===
2+
django CMS Python Django
3+
----------- ------------------------------ -------------------------------
4+
\ 3.12 3.11 3.10 3.9 3.8 3.7 3.6 5.0 4.2 4.1 4.0 3.2 3.1 3.0 2.2
5+
=========== ==== ==== ==== === === === === === === === === === === === ===
6+
4.1.x ✓ ✓ ✓ ✓ × × × ✓ LTS ✓ ✓ LTS × × ×
7+
3.11.3+ × ✓ ✓ ✓ ✓ ✓ × × LTS ✓ ✓ LTS × × ×
8+
3.11.1 × ✓ ✓ ✓ ✓ ✓ × × ✓ ✓ ✓ × × × ×
9+
3.11.0 × ✓ ✓ ✓ ✓ ✓ × × × × ✓ ✓ × × ×
10+
3.10.x × × ✓ ✓ ✓ ✓ × × × × × ✓ ✓ ✓ ✓
11+
3.9.x × × × ✓ ✓ ✓ ✓ × × × × ✓ ✓ ✓ ✓
12+
3.8.x × × × ✓ ✓ ✓ ✓ × × × × × ✓ ✓ LTS
13+
3.7.x × × × ✓ ✓ ✓ ✓ × × × × × × ✓ LTS
14+
=========== ==== ==== ==== === === === === === === === === === === === ===

‎docs/conf.py

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,23 @@
1111
# All configuration values have a default; values that are commented out serve
1212
# to show the default.
1313

14+
1415
import cms
1516
import datetime
1617
import os
1718
import sys
1819

20+
# Initialize Django for autodoc
21+
22+
sys.path.append(os.path.abspath('./'))
23+
24+
import django, django_settings
25+
26+
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_settings')
27+
django.setup()
28+
29+
30+
1931
# If extensions (or modules to document with autodoc) are in another
2032
# directory, add these directories to sys.path here. If the directory is
2133
# relative to the documentation root, use os.path.abspath to make it absolute,
@@ -33,19 +45,25 @@
3345

3446
extensions = [
3547
'djangocms',
48+
'sphinx.ext.autodoc',
49+
'sphinx.ext.autosummary',
50+
'sphinx.ext.doctest',
3651
'sphinx.ext.intersphinx',
3752
'sphinx.ext.todo',
38-
'sphinx.ext.autodoc',
39-
'sphinxcontrib.spelling'
53+
'sphinxcontrib.spelling',
54+
"sphinx_copybutton",
55+
"sphinxext.opengraph",
4056
]
4157
intersphinx_mapping = {
4258
'python': ('http://docs.python.org/3/', None),
43-
'django': ('https://docs.djangoproject.com/en/2.2/', 'https://docs.djangoproject.com/en/2.2/_objects/'),
59+
'django': ('https://docs.djangoproject.com/en/3.2/', 'https://docs.djangoproject.com/en/2.2/_objects/'),
4460
'classytags': ('http://readthedocs.org/docs/django-classy-tags/en/latest/', None),
4561
'sekizai': ('http://readthedocs.org/docs/django-sekizai/en/latest/', None),
4662
'treebeard': ('http://django-treebeard.readthedocs.io/en/latest/', None),
4763
}
4864

65+
autodoc_member_order = "groupwise"
66+
4967
# Add any paths that contain templates here, relative to this directory.
5068
# templates_path = ['_templates']
5169

@@ -55,13 +73,13 @@
5573
# The encoding of source files.
5674
source_encoding = 'utf-8'
5775

58-
# The master toctree document.
76+
# The main toctree document.
5977
master_doc = 'index'
6078

6179
current_year = datetime.datetime.now().year
6280
# General information about the project.
63-
project = u'django cms'
64-
copyright = u'2009-{}, Divio AG and contributors'.format(current_year)
81+
project = 'django cms'
82+
copyright = '2009-{}, django CMS Association and contributors'.format(current_year)
6583

6684
# The version info for the project you're documenting, acts as 97AE replacement for
6785
# |version| and |release|, also used in various other places throughout the
@@ -127,17 +145,17 @@
127145
# on_rtd is whether we are on readthedocs.org
128146
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
129147

130-
131148
try:
132149
import furo
133150

134151
html_theme = 'furo'
135152
html_theme_options = {
136153
"navigation_with_keys": True,
137154
}
138-
except ImportError:
155+
except: # NOQA
139156
html_theme = 'default'
140157

158+
141159
show_cloud_banner = True
142160

143161
# The theme to use for HTML and HTML Help pages. Major themes that come with
@@ -224,7 +242,7 @@
224242
# (source start file, target name, title, author, documentclass [howto/manual]).
225243
latex_documents = [
226244
('index', 'djangocms.tex', u'django cms Documentation',
227-
u'Divio AG and contributors', 'manual'),
245+
u'django CMS Association and contributors', 'manual'),
228246
]
229247

230248
# The name of an image file (relative to this directory) to place at the top
@@ -261,3 +279,8 @@
261279
spelling_word_list_filename = 'spelling_wordlist'
262280

263281
spelling_ignore_pypi_package_names = True
282+
283+
#Split common contractions from words so they are not flagged as errors by the spellchecker.
284+
#https://github.com/sphinx-contrib/spelling/blob/master/sphinxcontrib/spelling/filters.py
285+
#See https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html#word-filters
286+
spelling_filters=["sphinxcontrib.spelling.filters.ContractionFilter"]

‎docs/contributing/code.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Here's what the contribution process looks like in brief:
1717
#. Fork our `GitHub`_ repository, https://github.com/django-cms/django-cms
1818
#. Work locally and push your changes to your repository.
1919
#. When you feel your code is good enough for inclusion, send us a pull request.
20+
#. After that, please join the `Slack Channel`_ of our Pull Request Review work group (#workgroup-pr-review). This group of friendly community members is dedicated to reviewing pull requests. Report your PR and find a “pr review buddy” who is going to review your pull request.
21+
#. Get acknowledged by the django CMS community for your contribution
2022

2123
See the :ref:`contributing_patch` how-to document for a walk-through of this process.
2224

@@ -26,7 +28,7 @@ Basic requirements and standards
2628
********************************
2729

2830
If you're interested in developing a new feature for the CMS, it is recommended
29-
that you first discuss it on the `Discourse forum <https://discourse.django-cms.org>`_ so as
31+
that you first discuss it on the `Slack channel <https://www.django-cms.org/slack>`_ so as
3032
not to do any work that will not get merged in anyway.
3133

3234
- Code will be reviewed and tested by at least one core developer, preferably
@@ -105,8 +107,7 @@ coverage will only be accepted with a very good reason; bug-fixing patches
105107
**must** demonstrate the bug with a test to avoid regressions and to check
106108
that the fix works.
107109

108-
We have `a Slack group <https://www.django-cms.org/slack>`_, a `Discourse forum
109-
<https://discourse.django-cms.org>`_, and of course the code reviews mechanism on GitHub - do use them.
110+
We have a `Slack Channel`_ and of course the code reviews mechanism on GitHub - do use them.
110111

111112

112113
.. _contributing_frontend:
@@ -201,3 +202,4 @@ the source modules.
201202
.. _freenode: http://freenode.net/
202203
.. _pull request: http://help.github.com/send-pull-requests/
203204
.. _git: http://git-scm.com/
205+
.. _Slack Channel: https://django-cmsworkspace.slack.com/

‎docs/contributing/code_of_conduct.rst

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1-
###############
21
Code of Conduct
3-
###############
2+
===============
43

54
Participation in the django CMS project is governed by a code of conduct.
65

7-
The django CMS community is a pleasant one to be involved in for everyone, and
8-
we wish to keep it that way. Participants are expected to behave and
9-
communicate with others courteously and respectfully, whether online or in
10-
person, and to be welcoming, friendly and polite.
6+
The django CMS community is a pleasant one to be involved in for everyone, and we wish
7+
to keep it that way. Participants are expected to behave and communicate with others
8+
courteously and respectfully, whether online or in person, and to be welcoming, friendly
9+
and polite.
1110

1211
We will not tolerate abusive behaviour or language or any form of harassment.
1312

14-
Individuals whose behaviour is a cause for concern will be give a warning, and
15-
if necessary will be excluded from participation in official django CMS
16-
channels (Slack group, Discourse forum, email lists, IRC channels, etc) and
17-
events. The `Django Software Foundation
13+
Individuals whose behaviour is a cause for concern will be given a warning, and if
14+
necessary will be excluded from participation in official django CMS channels (Slack
15+
group, email lists, etc) and events. The `Django Software Foundation
1816
<http://djangoproject.com/foundation/>`_ will also be informed of the issue.
1917

20-
*****************
2118
Raising a concern
22-
*****************
19+
-----------------
2320

24-
If you have a concern about the behaviour of any member of the django CMS
25-
community, please contact one of the members of the :ref:`core development team
26-
<core_developers>`.
21+
If you have a concern about the behaviour of any member of the django CMS community,
22+
please contact us via info@django-cms.org and our Community Manager will reach out to
23+
you.
2724

28-
Your concerns will be taken seriously, treated as confidential and
29-
investigated. You will be informed, in writing and as promptly as possible, of
30-
the outcome.
25+
Your concerns will be taken seriously, treated as confidential and investigated. You
26+
will be informed, in writing and as promptly as possible, of the outcome.

0 commit comments

Comments
 (0)
0