ungleich-public/djangocms_blog
6
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix docs styling

Browse source
This commit is contained in:
Iacopo Spalletti 2016-06-26 12:25:12 +02:00
commit 874fde78be
No known key found for this signature in database
GPG key ID: BDCBC2EB289F60C6
7 changed files with 114 additions and 81 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/features.rst
View file

@ -1,12 +1,14 @@
.. _features:
========
Features
--------
========
.. _blog-home-page:
*******************************
Attaching blog to the home page
+++++++++++++++++++++++++++++++
*******************************
If you want to attach the blog to the home page you have to adapt settings a bit otherwise the
"Just slug" permalink will swallow any CMS page you create.
@ -32,13 +34,14 @@ linked ot the home page (see http://yoursite.com/admin/djangocms_blog/blogconfig
.. _multisite:
*********
Multisite
+++++++++
*********
django CMS blog provides full support for multisite setups.
Basic multisite
^^^^^^^^^^^^^^^
===============
To enabled basic multisite add ``BLOG_MULTISITE = True`` to the project settings.
@ -47,7 +50,7 @@ it's visible on all sites. All users with permission on the blog can manage all
posts, whichever the sites are.
Multisite permissions
^^^^^^^^^^^^^^^^^^^^^
=====================
Multisite permissions allow to restrict users to only manage the blog posts for the
sites they are enabled to
@ -65,8 +68,9 @@ Example::
.. _cms-wizard:
**********************
django CMS 3.2+ Wizard
++++++++++++++++++++++
**********************
django CMS 3.2+ provides a content creation wizard that allows to quickly created supported
content types, such as blog posts.
@ -80,8 +84,9 @@ wizard may not show up, but the rest will work as intended.
.. _permalinks:
***********************
Configurable permalinks
+++++++++++++++++++++++
***********************
Blog comes with four different styles of permalinks styles:
@ -106,8 +111,9 @@ And change ``post/`` with the desired prefix.
.. _menu:
****
Menu
++++
****
``djangocms_blog`` provides support for django CMS menu framework.
@ -121,8 +127,9 @@ category are not added to the menu.
.. _templates:
*********
Templates
+++++++++
*********
To ease the template customisations a ``djangocms_blog/base.html`` template is
used by all the blog templates; the templates itself extends a ``base.html``
@ -133,8 +140,9 @@ not defines a ``content`` block, copy in your template directory
other application templates will use the newly created base template and
will ignore the bundled one.
*************
Templates set
+++++++++++++
*************
By using **Apphook configuration** you can define a different templates set.
To use this feature provide a directory name in **Template prefix** field in
@ -143,8 +151,9 @@ root of your custom templates set.
.. _sitemap:
*******
Sitemap
+++++++
*******
``djangocms_blog`` provides a sitemap for improved SEO indexing.
Sitemap returns all the published posts in all the languages each post is available.
@ -168,14 +177,3 @@ To add the blog Sitemap, add the following code to the project ``urls.py``::
}
}),
)
.. _knocker:
django-knocker
++++++++++++++
``djangocms-blog`` is integrated with `django-knocker <https://github.com/nephila/django-knocker>`_
to provide real time desktop notifications.
See `django-knocker documentation <https://django-knocker.readthedocs.io/>`_ for how to configure
knocker.

8
docs/index.rst
View file

@ -3,14 +3,16 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==========================================
Welcome to djangocms-blog's documentation!
==========================================
.. include:: ../README.rst
********
Contents
--------
********
.. toctree::
:maxdepth: 2
@ -18,13 +20,15 @@ Contents
installation
settings
features
channels
development
contributing
history
******************
Indices and tables
==================
******************
* :ref:`genindex`
* :ref:`search`

12
docs/installation.rst
View file

@ -1,7 +1,8 @@
.. _installation:
############
Installation
------------
############
Install djangocms-blog::
@ -28,8 +29,9 @@ Then migrate::
$ python manage.py migrate
*********************
Minimal configuration
+++++++++++++++++++++
*********************
The following are minimal defaults to get the blog running; they may not be
suited for your deployment.
@ -90,8 +92,9 @@ suited for your deployment.
.. _external_applications:
***********************************
External applications configuration
+++++++++++++++++++++++++++++++++++
***********************************
Dependency applications may need configuration to work properly.
@ -106,8 +109,9 @@ Please, refer to each application documentation on details.
.. _auto_setup:
**********
Auto setup
++++++++++
**********
``djangocms_blog`` can install and configue itself if it does not find any
attached instance of itself.

10
docs/settings.rst
View file

@ -1,7 +1,9 @@
.. _settings:
###############
Global Settings
---------------
###############
* BLOG_IMAGE_THUMBNAIL_SIZE: Size of the main image when shown on the post
lists; it's a dictionary with ``size``, ``crop`` and ``upscale`` keys;
(default: ``{'size': '120x120', 'crop': True,'upscale': False}``)
@ -88,8 +90,9 @@ Global Settings
* BLOG_FEED_LATEST_ITEMS: Number of items in latest items feed
* BLOG_FEED_TAGS_ITEMS: Number of items in per tags feed
******************
Read-only settings
++++++++++++++++++
******************
* BLOG_MENU_TYPES: Available structures of the Blog menu; (default list **Posts and Categories**,
**Categories only**, **Posts only**, **None**)
@ -97,8 +100,9 @@ Read-only settings
(default: ``Posts and Categories``)
********************
Per-Apphook settings
++++++++++++++++++++
********************
The following settings can be configured for each ``Apphook config``: the settings above will
be used as defaults.