Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
sagemath
GitHub Repository: sagemath/sagelib
Path: blob/master/doc/en/reference/conf.py
4033 views
1
# -*- coding: utf-8 -*-
2
#
3
# Sage documentation build configuration file, created by
4
# sphinx-quickstart on Thu Aug 21 20:15:55 2008.
5
#
6
# This file is execfile()d with the current directory set to its containing dir.
7
#
8
# The contents of this file are pickled, so don't put values in the namespace
9
# that aren't pickleable (module imports are okay, they're removed automatically).
10
#
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13
14
import sys, os
15
sys.path.append(os.environ['SAGE_DOC'])
16
from common.conf import *
17
18
# General information about the project.
19
project = u"Sage Reference Manual"
20
name = "reference"
21
22
# The name for this set of Sphinx documents. If None, it defaults to
23
# "<project> v<release> documentation".
24
html_title = project + " v"+release
25
26
html_short_title = u'Sage Reference v' + release
27
28
# Output file base name for HTML help builder.
29
htmlhelp_basename = name
30
31
# Grouping the document tree into LaTeX files. List of tuples
32
# (source start file, target name, title, author, document class [howto/manual]).
33
latex_documents = [
34
('index', name + '.tex', u'Sage Reference Manual',
35
u'The Sage Development Team', 'manual'),
36
]
37
38
latex_elements['preamble'] += r'''
39
% One-column index
40
\makeatletter
41
\renewenvironment{theindex}{
42
\chapter*{\indexname}
43
\markboth{\MakeUppercase\indexname}{\MakeUppercase\indexname}
44
\setlength{\parskip}{0.1em}
45
\relax
46
\let\item\@idxitem
47
}{}
48
\makeatother
49
'''
50
51
#Ignore all .rst in the _sage subdirectory
52
exclude_trees = exclude_trees + ['_sage']
53
54