Some updates to the docs config file

This commit is contained in:
Veronica K. B. Olsen
2020-07-30 00:18:08 +02:00
parent f5cc67d33f
commit 57f199ef17
+24 -30
View File
@@ -15,7 +15,7 @@
# import os # import os
# import sys # import sys
# sys.path.insert(0, os.path.abspath(".")) # sys.path.insert(0, os.path.abspath("."))
import sphinx_rtd_theme
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@@ -32,13 +32,13 @@ release = "0.10.2"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = "1.0" # needs_sphinx = "1.0"
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named "sphinx.ext.*") or your custom # extensions coming with Sphinx (named "sphinx.ext.*") or your custom
# ones. # ones.
extensions = [ extensions = [
"sphinx_rtd_theme",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@@ -46,7 +46,6 @@ templates_path = ["_templates"]
# The suffix(es) of source filenames. # The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
#
# source_suffix = [".rst", ".md"] # source_suffix = [".rst", ".md"]
source_suffix = ".rst" source_suffix = ".rst"
@@ -55,7 +54,6 @@ master_doc = "index"
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = None
@@ -73,28 +71,28 @@ pygments_style = None
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme = "sphinx_rtd_theme"
html_theme = "default" html_theme_options = {
# Toc options
# Theme options are theme-specific and customize the look and feel of a theme 'collapse_navigation': True,
# further. For a list of options available for each theme, see the 'sticky_navigation': True,
# documentation. 'navigation_depth': 3,
# 'includehidden': True,
# html_theme_options = {} 'titles_only': False
}
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"] # html_static_path = ["_static"]
html_static_path = []
# Custom sidebar templates, must be a dictionary that maps document names # Custom sidebar templates, must be a dictionary that maps document names
# to template names. # to template names.
#
# The default sidebars (for documents that don"t match any pattern) are # The default sidebars (for documents that don"t match any pattern) are
# defined by theme itself. Builtin themes are using these templates by # defined by theme itself. Builtin themes are using these templates by
# default: ``["localtoc.html", "relations.html", "sourcelink.html", # default: ``["localtoc.html", "relations.html", "sourcelink.html",
# "searchbox.html"]``. # "searchbox.html"]``.
#
# html_sidebars = {} # html_sidebars = {}
@@ -127,20 +125,19 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [(
(master_doc, "novelWriter.tex", "novelWriter Documentation", master_doc, "novelWriter.tex", "novelWriter Documentation",
"Veronica Berglyd Olsen", "manual"), author, "manual"
] )]
# -- Options for manual page output ------------------------------------------ # -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [(
(master_doc, "novelwriter", "novelWriter Documentation", master_doc, "novelwriter", "novelWriter Documentation", [author], 1
[author], 1) )]
]
# -- Options for Texinfo output ---------------------------------------------- # -- Options for Texinfo output ----------------------------------------------
@@ -148,11 +145,10 @@ man_pages = [
# Grouping the document tree into Texinfo files. List of tuples # Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [(
(master_doc, "novelWriter", "novelWriter Documentation", master_doc, "novelWriter", "novelWriter Documentation", author,
author, "novelWriter", "Markdown-like editor for novels.", "novelWriter", "Markdown-like editor for novels.", "Miscellaneous"
"Miscellaneous"), )]
]
# -- Options for Epub output ------------------------------------------------- # -- Options for Epub output -------------------------------------------------
@@ -162,11 +158,9 @@ epub_title = project
# The unique identifier of the text. This can be a ISBN number # The unique identifier of the text. This can be a ISBN number
# or the project homepage. # or the project homepage.
#
# epub_identifier = "" # epub_identifier = ""
# A unique identification for the text. # A unique identification for the text.
#
# epub_uid = "" # epub_uid = ""
# A list of files that should not be packed into the epub file. # A list of files that should not be packed into the epub file.