update docs
This commit is contained in:
parent
73142e9cd4
commit
b7a4c8d187
37
docs/conf.py
37
docs/conf.py
|
@ -1,8 +1,7 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# embark documentation build configuration file, created by
|
||||
# sphinx-quickstart on Tue Jan 10 06:39:27 2017.
|
||||
# ENS documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Dec 15 16:45:41 2016.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
|
@ -22,12 +21,6 @@
|
|||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
import sphinx_rtd_theme
|
||||
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
|
@ -37,7 +30,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = []
|
||||
extensions = ['sphinx.ext.mathjax']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
@ -52,18 +45,18 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'embark'
|
||||
copyright = '2017, Iuri Matias'
|
||||
author = 'Iuri Matias'
|
||||
project = u'Embark'
|
||||
copyright = u'2017, Iuri Matias <iuri.matias@gmail.com>'
|
||||
author = u'Iuri Matias <iuri.matiasl@gmail.com>'
|
||||
|
||||
# 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 = '2.1.4'
|
||||
version = u'2.1'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.1.4'
|
||||
release = u'2.1.4'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
@ -89,7 +82,7 @@ todo_include_todos = False
|
|||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# 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
|
||||
|
@ -106,7 +99,7 @@ html_static_path = ['_static']
|
|||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'embarkdoc'
|
||||
htmlhelp_basename = 'Embarkdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
@ -133,8 +126,8 @@ latex_elements = {
|
|||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'embark.tex', 'embark Documentation',
|
||||
'Iuri Matias', 'manual'),
|
||||
(master_doc, 'Embark.tex', u'Embark Documentation',
|
||||
u'Iuri Matias \\textless{}iuri.matias@gmail.com\\textgreater{}', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
|
@ -143,7 +136,7 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'embark', 'embark Documentation',
|
||||
(master_doc, 'embark', u'Embark Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
@ -154,8 +147,8 @@ man_pages = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'embark', 'embark Documentation',
|
||||
author, 'embark', 'One line description of project.',
|
||||
(master_doc, 'Embark', u'Embark Documentation',
|
||||
author, 'Embark', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
Loading…
Reference in New Issue