Skip to content

Commit 608af82

Browse files
committed
DOC: fix documentation project name
Name it consistently as `diffpy.srreal`.
1 parent e421a42 commit 608af82

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

doc/manual/source/conf.py

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22
# -*- coding: utf-8 -*-
33
#
4-
# diffpy.SrReal documentation build configuration file, created by
4+
# diffpy.srreal documentation build configuration file, created by
55
# sphinx-quickstart on Tue Oct 22 12:02:48 2013.
66
#
77
# This file is execfile()d with the current directory set to its containing dir.
@@ -12,17 +12,18 @@
1212
# All configuration values have a default; values that are commented out
1313
# serve to show the default.
1414

15-
import sys, os
15+
import sys
16+
import os
1617
import time
1718

1819
# If extensions (or modules to document with autodoc) are in another directory,
1920
# add these directories to sys.path here. If the directory is relative to the
2021
# documentation root, use os.path.abspath to make it absolute, like shown here.
21-
# sys.path.insert(0, os.path.abspath('.'))
22-
# sys.path.insert(0, os.path.abspath('../../..'))
22+
#sys.path.insert(0, os.path.abspath('.'))
23+
sys.path.insert(0, os.path.abspath('../../..'))
2324

2425
# abbreviations
25-
ab_authors = 'Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group'
26+
ab_authors = u'Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group'
2627

2728
# -- General configuration -----------------------------------------------------
2829

@@ -51,16 +52,14 @@
5152
master_doc = 'index'
5253

5354
# General information about the project.
54-
project = 'SrReal'
55+
project = 'diffpy.srreal'
5556
copyright = '%Y, Brookhaven National Laboratory'
5657

5758
# The version info for the project you're documenting, acts as replacement for
5859
# |version| and |release|, also used in various other places throughout the
5960
# built documents.
60-
sys.path.insert(0, os.path.abspath('../../..'))
6161
from setup import versiondata
6262
fullversion = versiondata.get('DEFAULT', 'version')
63-
sys.path.remove(os.path.abspath('../../..'))
6463
# The short X.Y version.
6564
version = ''.join(fullversion.split('.post')[:1])
6665
# The full version, including alpha/beta/rc tags.
@@ -188,7 +187,7 @@
188187
# html_file_suffix = None
189188

190189
# Output file base name for HTML help builder.
191-
htmlhelp_basename = 'SrRealdoc'
190+
htmlhelp_basename = 'srrealdoc'
192191

193192

194193
# -- Options for LaTeX output --------------------------------------------------
@@ -207,7 +206,7 @@
207206
# Grouping the document tree into LaTeX files. List of tuples
208207
# (source start file, target name, title, author, documentclass [howto/manual]).
209208
latex_documents = [
210-
('index', 'SrReal_manual.tex', 'SrReal Documentation',
209+
('index', 'diffpy.srreal.tex', 'diffpy.srreal Documentation',
211210
ab_authors, 'manual'),
212211
]
213212

@@ -237,7 +236,7 @@
237236
# One entry per manual page. List of tuples
238237
# (source start file, name, description, authors, manual section).
239238
man_pages = [
240-
('index', 'srreal', 'SrReal Documentation',
239+
('index', 'diffpy.srreal', 'diffpy.srreal Documentation',
241240
ab_authors, 1)
242241
]
243242

@@ -251,8 +250,8 @@
251250
# (source start file, target name, title, author,
252251
# dir menu entry, description, category)
253252
texinfo_documents = [
254-
('index', 'SrReal', 'SrReal Documentation',
255-
ab_authors, 'SrReal', 'One line description of project.',
253+
('index', 'diffpy.srreal', 'diffpy.srreal Documentation',
254+
ab_authors, 'diffpy.srreal', 'One line description of project.',
256255
'Miscellaneous'),
257256
]
258257

0 commit comments

Comments
 (0)