Skip to content

Extend documentation on using reST files for galleries overview pages #3864

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.

Sign up for GitHub

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

Open
CarstenGrohmann wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extend documentation on using reST files for galleries overview pages #3864

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2088,10 +2088,14 @@ The ``conf.py`` options affecting images and gallery pages are these:
IMAGE_THUMBNAIL_SIZE = 400
IMAGE_THUMBNAIL_FORMAT = '{name}.thumbnail{ext}'

If you add a reST file in ``galleries/gallery_name/index.txt`` its contents will be
converted to HTML and inserted above the images in the gallery page. The
format is the same as for posts. You can use the ``title``, ``previewimage``, and
``status`` metadata fields to change how the gallery is shown.
If you add a reST file ``galleries/gallery_name/index.txt``, its contents will be
converted to HTML and inserted above the images on the gallery page. The format is the
same as for posts. You can use the ``title``, ``previewimage``, and ``status`` metadata
fields to control how the gallery is displayed.

Additionally, you can add a reST file ``galleries/index.txt`` for the same purpose.
Its contents will also be converted to HTML and inserted above the gallery overview.
The format and available metadata fields are the same as for posts and gallery indexes.

If the ``status`` is ``private``, ``draft``, or ``publish_later``, the
gallery will not appear in the index, the RSS feeds, nor in the sitemap.
Expand Down