-
Notifications
You must be signed in to change notification settings - Fork 32
docs: Fix inconsistency in Documentation #329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
🧙 Sourcery has finished reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #329 +/- ##
=======================================
Coverage 89.00% 89.00%
=======================================
Files 124 124
Lines 3383 3383
Branches 287 287
=======================================
Hits 3011 3011
Misses 256 256
Partials 116 116 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Updated formatting and wording for clarity in the documentation on extending frontend plugins.
| ``DJANGOCMS_FRONTEND_THEME`` and defaults to ``djangocms_frontend``. | ||
| ``DJANGOCMS_FRONTEND_THEME`` and defaults to ``theme``. | ||
| For a theme app called ``theme`` and the bootstrap5 framework this | ||
| would be ``theme.frontends.bootstrap5.py``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, in the below example the module is `theme.frameworks.bootstrap5.py. So does this line need updating as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it does!
| =============== | ||
| Working example: Extending the ``GridContainerPlugin`` | ||
| ====================================================== | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right after the first paragraph where you're instructed to create the theme app, I would add a new (or a note) saying something along the lines of:
Make sure you make the necessary changes in your
settings.pyfile: your theme app should be added to the list ofINSTALLED_APPS, plus pointed to by theDJANGOCMS_FRONTEND_THEMEsetting:INSTALLED_APPS = [ ..., 'theme', ... ] DJANGOCMS_FRONTEND_THEME ="theme"```
Issue fix docs
Summary by Sourcery
Documentation: