From c347e3be42029239cf33e51bb71b34b76f60368b Mon Sep 17 00:00:00 2001 From: Alexis Metaireau Date: Wed, 15 Dec 2010 18:01:29 +0000 Subject: [PATCH] Switch back the theme. Order the settings. --- docs/conf.py | 6 ++--- docs/index.rst | 21 ++++++++------- docs/settings.rst | 65 +++++++++++++++++++++++++---------------------- 3 files changed, 48 insertions(+), 44 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 159ddbcc..0efe92b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,14 +21,14 @@ pygments_style = 'sphinx' # a list of builtin themes. sys.path.append(os.path.abspath('_themes')) html_theme_path = ['_themes'] -html_theme = 'flask' +html_theme = 'flask_small' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. html_theme_options = { -# 'index_logo': 'pelican.png', -# 'github_fork': 'ametaireau/pelican', + 'index_logo': 'pelican.png', + 'github_fork': 'ametaireau/pelican', } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 9af7ff6b..5fd8f8b7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,17 +9,6 @@ Pelican is a simple weblog generator, writen in python. * Easy to interface with DVCSes and web hooks * Completely static output, so easy to host anywhere ! -Documentation -============= - -.. toctree:: - :maxdepth: 2 - - getting_started - settings - themes - internals - Features ======== @@ -51,3 +40,13 @@ the repository, etc. That's open source, dude! Contact me at "alexis at notmyidea dot org" for any request/feedback ! +Documentation +============= + +.. toctree:: + :maxdepth: 2 + + getting_started + settings + themes + internals diff --git a/docs/settings.rst b/docs/settings.rst index e2876f96..d1b84e0a 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -9,40 +9,17 @@ the command line:: $ pelican -s path/to/your/settingsfile.py path +Settings are given as the form of a python module (a file). You can have an +example by looking at `/samples/pelican.conf.py +`_ + Here are the available settings. Please note that all the settings you put in this file will be passed to the templates as well. ======================= ======================================================= Setting name what it does ? ======================= ======================================================= -`SITEURL` base URL of your website. -`PATH` path to look at for input files. -`THEME` theme to use to product the output. can be the - complete static path to a theme folder, or chosen - between the list of default themes (see below) -`OUTPUT_PATH` Where to output the generated files. Default to - "output" -`SITENAME` Your site name, -`DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template. - Templates can follow or not this settings. -`PDF_PROCESSOR` Put True if you want to have PDF versions of your - documents. You will need to install `rst2pdf`. -`DEFAULT_CATEGORY` The default category to fallback on. `misc` by default. -`FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos - (mtime) if it can't get informations from the - metadata? -`MARKUP` A list of available markup languages you want to use. - moment, only available values are `rst` and `md`. -`STATIC_PATHS` The static paths you want to have accessible on the - output path "static". By default, pelican will copy - the 'images' folder to the output folder. -`STATIC_THEME_PATHS` Static theme paths you want to copy. Default values - is `static`, but if your theme have others static paths, - you can put them here. -`FEED` relative url to output the atom feed. Default is - `feeds/all.atom.xml` -`FEED_RSS` relative url to output the rss feed. Default is - None (no rss) +`AUTHOR` Default author (put your name) `CATEGORY_FEED` Where to put the atom categories feeds. default is `feeds/%s.atom.xml`, where %s is the name of the category. @@ -50,10 +27,38 @@ Setting name what it does ? (no rss) `CSS_FILE` To specify the CSS file you want to load, if it's not the default one ('main.css') -`REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in - descending order: the newer first) +`DEFAULT_CATEGORY` The default category to fallback on. `misc` by default. +`DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template. + Templates can follow or not this settings. +`FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos + (mtime) if it can't get informations from the + metadata? +`FEED` relative url to output the atom feed. Default is + `feeds/all.atom.xml` +`FEED_RSS` relative url to output the rss feed. Default is + None (no rss) `KEEP_OUTPUT_DIRECTORY` Keep the output directory and just update all the generated files. Default is to delete the output directory. +`MARKUP` A list of available markup languages you want to use. + moment, only available values are `rst` and `md`. +`OUTPUT_PATH` Where to output the generated files. Default to + "output" +`PATH` path to look at for input files. +`PDF_PROCESSOR` Put True if you want to have PDF versions of your + documents. You will need to install `rst2pdf`. +`REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in + descending order: the newer first) +`SITEURL` base URL of your website. +`SITENAME` Your site name, +`STATIC_PATHS` The static paths you want to have accessible on the + output path "static". By default, pelican will copy + the 'images' folder to the output folder. +`STATIC_THEME_PATHS` Static theme paths you want to copy. Default values + is `static`, but if your theme have others static paths, + you can put them here. +`THEME` theme to use to product the output. can be the + complete static path to a theme folder, or chosen + between the list of default themes (see below) ======================= ======================================================= Themes