From 6c5b7bbed0fde7bdf6aa883a8a9909a532303946 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Fri, 16 Jun 2017 22:16:01 +0200 Subject: [PATCH] Custom docs front page --- doc/_templates/index.html | 144 ++++++++++++++++++ doc/_themes/pretix_theme/static/css/theme.css | 24 +++ doc/conf.py | 6 +- doc/contents.rst | 11 ++ doc/index.rst | 13 -- 5 files changed, 183 insertions(+), 15 deletions(-) create mode 100644 doc/_templates/index.html create mode 100644 doc/contents.rst delete mode 100644 doc/index.rst diff --git a/doc/_templates/index.html b/doc/_templates/index.html new file mode 100644 index 0000000000..b075e43eaa --- /dev/null +++ b/doc/_templates/index.html @@ -0,0 +1,144 @@ +{% extends "layout.html" %} +{% set title = 'Overview' %} +{% block body %} +

Welcome to pretix' documentation!

+

+ We work hard to make this website contain all information that you need to use, run, understand, and improve + pretix. Of course, this documentation will never be perfect or complete, but if there is anything unclear + or anything specific that you miss here, that's a bug and we'd be happy if you'd + let us know. +

+ +

Documentation structure

+ +
+
+ + + +
+
+ + User Guide + +

Go here to find information on how to configure and use pretix as an event organizer.

+
+
+
+
+ + + +
+
+ + Administrator docs + +

Find out how to install pretix on your own server and how to maintain an installation of pretix.

+
+
+
+
+
+ + + +
+
+ + Developer docs + +

Get information on how to contribute to pretix itself and how to build plugins that interact with + pretix.

+
+
+
+
+ + + +
+
+ + Plugin docs + +

Documentation and details on plugins that ship with pretix or are officially supported.

+
+
+
+
+
+ + + +
+
+ + Table of contents + +

Detailled overview of everything contained in this documentation.

+
+
+
+ +

Useful links

+ +
+
+ + + +
+
+ + Project website + +

pretix.eu is the central entry-point to the pretix project and also the home of the commercial hosting + service available.

+
+
+
+
+ + + +
+
+ + GitHub repository + +

Our main source code repository contains all code that is part of pretix as well as some plugins and the + source for this documentation.

+
+
+
+
+
+ + + +
+
+ + Project blog + +

This important information source contains all release notes for all stable releases of pretix as well as + general news on pretix as a project.

+
+
+
+
+ + + +
+
+ + Twitter + +

Keep in touch and stay up to date by following our project account on Twitter.

+
+
+
+ +{% endblock %} \ No newline at end of file diff --git a/doc/_themes/pretix_theme/static/css/theme.css b/doc/_themes/pretix_theme/static/css/theme.css index 5fe7b76cd3..2ac7709877 100644 --- a/doc/_themes/pretix_theme/static/css/theme.css +++ b/doc/_themes/pretix_theme/static/css/theme.css @@ -6028,3 +6028,27 @@ url('../opensans_regular_macroman/OpenSans-Regular-webfont.svg#open_sansregular' font-style: normal; } + + +/* Frontpage */ +.sectionbox { + width: 50%; + float: left; + min-height: 70px; +} +.sectionbox .icon { + float: left; + font-size: 48px; + width: 70px; + text-align: center; +} +.sectionbox .text { + margin-left: 70px; +} + +@media screen and (max-width: 480px) { + .sectionbox { + width: 100%; + float: none; + } +} diff --git a/doc/conf.py b/doc/conf.py index 3936709115..1cfbeeb1b3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -53,7 +53,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = 'contents' # General information about the project. project = 'pretix' @@ -167,7 +167,9 @@ html_static_path = [ # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +html_additional_pages = { + 'index': 'index.html' +} # If false, no module index is generated. html_domain_indices = False diff --git a/doc/contents.rst b/doc/contents.rst new file mode 100644 index 0000000000..75b4fecdfb --- /dev/null +++ b/doc/contents.rst @@ -0,0 +1,11 @@ +Table of contents +================= + +.. toctree:: + :maxdepth: 3 + + user/index + admin/index + development/index + plugins/index + diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index aecab08637..0000000000 --- a/doc/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -Welcome to pretix's documentation! -================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - - user/index - admin/index - development/index - plugins/index -