mirror of
https://github.com/PeridexisErrant/DF-Walkthrough.git
synced 2026-01-29 11:46:10 +01:00
Simplify config, improve sidebar
This commit is contained in:
PeridexisErrant
parent
c486ee3a0b
commit
bd1d8ce719
6 changed files with 40 additions and 292 deletions
145
conf.py
145
conf.py
|
|
@ -16,6 +16,7 @@
|
|||
import sys
|
||||
import os
|
||||
import shlex
|
||||
from time import strftime
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
|
|
@ -23,18 +24,17 @@ import shlex
|
|||
#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.
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinx.ext.extlinks',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = []
|
||||
templates_path = ['misc/_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
source_suffix = ['.rst']
|
||||
# You can specify multiple suffix as a list of strings:
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
|
@ -44,23 +44,16 @@ master_doc = 'index'
|
|||
|
||||
# General information about the project.
|
||||
project = 'PeridexisErrant\'s DF Walkthrough'
|
||||
copyright = '2015, PeridexisErrant'
|
||||
author = 'PeridexisErrant'
|
||||
copyright = '{}, {}'.format(strftime('%Y'), author)
|
||||
|
||||
# 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 = '0.2'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.2'
|
||||
# built documents. version is x.y; release includes .alpha1 or w/e.
|
||||
version = release = '0.2'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# If true, Sphinx will warn about all references where the target cannot
|
||||
|
|
@ -74,21 +67,11 @@ today_fmt = '%Y-%m-%d'
|
|||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
exclude_patterns = ['_build/**', '**.md']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
# The reST default role (used for this markup: `text`) for all documents.
|
||||
default_role = 'ref'
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
|
||||
# This config value must be a dictionary of external sites, mapping unique
|
||||
# short alias names to a base URL and a prefix.
|
||||
# See http://sphinx-doc.org/ext/extlinks.html
|
||||
|
|
@ -103,11 +86,11 @@ extlinks = {
|
|||
extlinks['forum'] = extlinks['forums']
|
||||
extlinks['DFFD'] = extlinks['dffd']
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
#intersphinx_mapping = {'https://docs.python.org/': None}
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# See https://github.com/bitprophet/alabaster#variables-and-feature-toggles
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'alabaster'
|
||||
|
|
@ -116,13 +99,14 @@ html_style = 'dftext.css'
|
|||
# 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 = {}
|
||||
html_theme_options = {
|
||||
'logo': 'logo.png',
|
||||
'description': 'Learning (and losing) can be fun!',
|
||||
'github_button': False,
|
||||
'show_powered_by': False,
|
||||
}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# 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.
|
||||
html_title = project
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
|
|
@ -130,7 +114,7 @@ html_title = project
|
|||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as the favicon
|
||||
html_favicon = 'misc/df-icon.ico'
|
||||
|
|
@ -149,20 +133,11 @@ html_last_updated_fmt = ''
|
|||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
# "misc/_templates/searchbox.html" is customised to remove API-related text
|
||||
html_sidebars = {'**': ['about.html', 'localtoc.html', 'searchbox.html']}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
html_domain_indices = False
|
||||
|
||||
# If false, no index is generated.
|
||||
html_use_index = False
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
# If false, no index or module index is generated.
|
||||
html_use_index = html_domain_indices = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
|
@ -173,30 +148,6 @@ html_show_sphinx = False
|
|||
# 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 = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Language to be used for generating the HTML full-text search index.
|
||||
# Sphinx supports the following languages:
|
||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
|
||||
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
|
||||
#html_search_language = 'en'
|
||||
|
||||
# A dictionary with options for the search language support, empty by default.
|
||||
# Now only 'ja' uses this config value
|
||||
#html_search_options = {'type': 'default'}
|
||||
|
||||
# The name of a javascript file (relative to the configuration directory) that
|
||||
# implements a search results scorer. If empty, the default will be used.
|
||||
#html_search_scorer = 'scorer.js'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'PeridexisErrantsDFWalkthroughdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
|
|
@ -246,50 +197,6 @@ latex_documents = [
|
|||
#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 = [
|
||||
(master_doc,
|
||||
'peridexiserrantsdfwalkthrough',
|
||||
'PeridexisErrant\'s DF Walkthrough Documentation',
|
||||
[author],
|
||||
1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc,
|
||||
'PeridexisErrantsDFWalkthrough',
|
||||
'PeridexisErrant\'s DF Walkthrough Documentation',
|
||||
author,
|
||||
'PeridexisErrantsDFWalkthrough',
|
||||
'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
|
|
@ -312,11 +219,11 @@ epub_copyright = copyright
|
|||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
epub_scheme = 'URL'
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
epub_identifier = 'https://df-walkthrough.readthedocs.org'
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue