Minor fixes.

[wolnelektury.git] / doc / conf.py

diff --git a/doc/conf.py b/doc/conf.py
index 60d7d55..7c09286 100644 (file)
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
-#
-# WolneLektury.pl documentation build configuration file, created by
-# sphinx-quickstart on Tue Jun 16 18:49:15 2009.
+# Wolne Lektury documentation build configuration file, created by
+# sphinx-quickstart on Fri Mar 30 16:42:44 2012.

 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #


@@ -12,27 +10,29 @@
 # serve to show the default.
 
 import sys, os
 # serve to show the default.
 
 import sys, os

-from os.path import abspath, join, dirname
-
-sys.path.insert(0, abspath(join(dirname(__file__), '../wolnelektury')))
-sys.path.insert(0, abspath(join(dirname(__file__), '../apps')))
-sys.path.insert(0, abspath(join(dirname(__file__), '../lib')))
+import django

 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

-#sys.path.append(os.path.abspath('.'))
+#sys.path.insert(0, os.path.abspath('.'))
+sys.path += [
+    os.path.abspath('../src'),
+]
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "wolnelektury.settings")
+django.setup()
+
+

 
 # -- General configuration -----------------------------------------------------
 
 
 # -- General configuration -----------------------------------------------------
 

+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+

 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.intersphinx']
-
-intersphinx_mapping = {
-    'http://docs.python.org/dev': None,
-    'http://docs.djangoproject.com/en/dev': 'http://docs.djangoproject.com/en/dev/_objects',
-}
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']

 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']


@@ -41,27 +41,27 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
 source_suffix = '.rst'
 
 # The encoding of source files.

-source_encoding = 'utf-8'
+#source_encoding = 'utf-8-sig'

 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.
 
 # The master toctree document.
 master_doc = 'index'
 
 # General information about the project.

-project = u'WolneLektury.pl'
-copyright = u'2007, Fundacja Nowoczesna Polska'
+project = 'Wolne Lektury'
+copyright = '2007-2019, Fundacja Nowoczesna Polska'

 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.

-version = '1.0'
+version = '1.8'

 # The full version, including alpha/beta/rc tags.
 # The full version, including alpha/beta/rc tags.

-release = '1.0'
+release = '1.8'

 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

-language = 'pl'
+#language = None

 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:


@@ -69,12 +69,9 @@ language = 'pl'
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'
 

-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['_build']
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']

 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None


@@ -99,8 +96,8 @@ pygments_style = 'sphinx'
 
 # -- Options for HTML output ---------------------------------------------------
 
 
 # -- Options for HTML output ---------------------------------------------------
 

-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.

 html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme


@@ -113,7 +110,7 @@ html_theme = 'default'
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

-html_title = u'%s %s - dokumentacja' % (project, version)
+#html_title = None

 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None


@@ -130,7 +127,7 @@ html_title = u'%s %s - dokumentacja' % (project, version)
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".

-html_static_path = ['_static']
+#html_static_path = ['_static']

 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.


@@ -148,7 +145,7 @@ html_static_path = ['_static']
 #html_additional_pages = {}
 
 # If false, no module index is generated.
 #html_additional_pages = {}
 
 # If false, no module index is generated.

-#html_use_modindex = True
+#html_domain_indices = True

 
 # If false, no index is generated.
 #html_use_index = True
 
 # If false, no index is generated.
 #html_use_index = True


@@ -159,16 +156,22 @@ html_static_path = ['_static']
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
 
 # If true, links to the reST sources are added to the pages.
 #html_show_sourcelink = True
 

+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+

 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
 #html_use_opensearch = ''
 

-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None

 
 # Output file base name for HTML help builder.
 
 # Output file base name for HTML help builder.

-htmlhelp_basename = 'WolneLekturypldoc'
+htmlhelp_basename = 'WolneLekturydoc'

 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 
 # -- Options for LaTeX output --------------------------------------------------


@@ -182,8 +185,8 @@ htmlhelp_basename = 'WolneLekturypldoc'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [

-  ('index', 'WolneLekturypl.tex', u'WolneLektury.pl Documentation',
-   u'Marek Stepniowski', 'manual'),
+  ('index', 'WolneLektury.tex', 'Wolne Lektury Documentation',
+   'Fundacja Nowoczesna Polska', 'manual'),

 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 ]
 
 # The name of an image file (relative to this directory) to place at the top of


@@ -194,6 +197,12 @@ latex_documents = [
 # not chapters.
 #latex_use_parts = False
 
 # not chapters.
 #latex_use_parts = False
 

+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+

 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 


@@ -201,4 +210,21 @@ latex_documents = [
 #latex_appendices = []
 
 # If false, no module index is generated.
 #latex_appendices = []
 
 # If false, no module index is generated.

-#latex_use_modindex = True
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'wolnelektury', 'Wolne Lektury Documentation',
+     ['Fundacja Nowoczesna Polska'], 1)
+]
+
+extlinks = {
+    'django': (
+        'https://docs.djangoproject.com/en/%d.%d/%%s' % django.VERSION[:2],
+        None
+    )
+}