mirror of
https://github.com/wxWidgets/Phoenix.git
synced 2025-12-16 09:40:07 +01:00
Docs: fixes and updates to sphinx configuration
This commit is contained in:
@@ -14,6 +14,7 @@
|
||||
|
||||
import sys, os
|
||||
from datetime import datetime
|
||||
from buildtools.config import Config
|
||||
|
||||
# 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
|
||||
@@ -37,7 +38,7 @@ extensions = ["sphinxcontrib.jquery",
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
source_suffix = ['.txt']
|
||||
source_suffix = {'.txt': 'restructuredtext'}
|
||||
|
||||
todo_include_todos = True
|
||||
todo_all_todos = True
|
||||
@@ -50,6 +51,7 @@ availability_all_availabilities = True
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
toc_object_entries = False
|
||||
|
||||
# General information about the project.
|
||||
project = u'wxPython Phoenix'
|
||||
@@ -59,7 +61,6 @@ copyright = u'2012-{}, The wxPython Team'.format(datetime.now().year)
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
|
||||
from buildtools.config import Config
|
||||
cfg = Config(noWxConfig=True)
|
||||
|
||||
# The short X.Y version.
|
||||
@@ -67,7 +68,6 @@ version = '%s.%s' % (cfg.VER_MAJOR, cfg.VER_MINOR)
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = cfg.VERSION
|
||||
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
@@ -102,11 +102,10 @@ show_authors = True
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
keep_warnings = False
|
||||
show_warning_types = True
|
||||
supress_warnings = []
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
@@ -166,11 +165,15 @@ html_sidebars = {
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
html_additional_pages = {'gallery': 'gallery.html', 'main': 'main.html'}
|
||||
html_additional_pages = {'gallery': 'gallery.html',
|
||||
'main': 'main.html'}
|
||||
|
||||
# If false, no module index is generated.
|
||||
html_use_modindex = True
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
modindex_common_prefix = ['wx.', 'wx.lib.', 'wx.py.']
|
||||
|
||||
# If false, no index is generated.
|
||||
html_use_index = True
|
||||
|
||||
@@ -281,3 +284,4 @@ pdf_verbosity = 2
|
||||
# Enable experimental feature to split table cells. Use it
|
||||
# if you get "DelayedTable too big" errors
|
||||
pdf_splittables = True
|
||||
|
||||
|
||||
Reference in New Issue
Block a user