1212# All configuration values have a default; values that are commented out
1313# serve to show the default.
1414
15+ import os
16+ import sys
17+
1518# If extensions (or modules to document with autodoc) are in another
1619# directory, add these directories to sys.path here. If the directory is
1720# relative to the documentation root, use os.path.abspath to make it
1821# absolute, like shown here.
1922#
2023import obsarray
21- import os
22- import sys
24+
25+ sys .path .insert (0 , os .path .abspath ('..' ))
26+
27+ project_title = "obsarray" .replace ("_" , " " ).title ()
28+
29+ # -- General configuration ---------------------------------------------
30+
31+ latex_toplevel_sectioning = 'section'
32+
33+ # If your documentation needs a minimal Sphinx version, state it here.
34+ #
35+ # needs_sphinx = '1.0'
36+
37+ # Attempt to make links automatially
38+ default_role = "code"
39+
40+ # Add any Sphinx extension module names here, as strings. They can be
41+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
42+ # CFAB added napolean to support google-style docstrings
43+ extensions = [
44+ 'sphinx.ext.autodoc' ,
45+ 'sphinx.ext.viewcode' ,
46+ 'sphinx.ext.napoleon' ,
47+ ]
48+
49+ # Add any paths that contain templates here, relative to this directory.
50+ templates_path = ['_templates' ]
51+
52+ # The suffix(es) of source filenames.
53+ # You can specify multiple suffix as a list of string:
54+ #
55+ # source_suffix = ['.rst', '.md']
56+ source_suffix = '.rst'
57+
58+ # The master toctree document.
59+ master_doc = 'index'
60+
61+ # General information about the project.
62+ project = project_title
63+ copyright = "Sam Hunt"
64+ author = "Sam Hunt"
65+
66+ # The version info for the project you're documenting, acts as replacement
67+ # for |version| and |release|, also used in various other places throughout
68+ # the built documents.
69+ #
70+ # The short X.Y version.
71+ version = obsarray .__version__
72+ # The full version, including alpha/beta/rc tags.
73+ release = obsarray .__version__
74+
75+ # The language for content autogenerated by Sphinx. Refer to documentation
76+ # for a list of supported languages.
77+ #
78+ # This is also used if you do content translation via gettext catalogs.
79+ # Usually you set "language" from the command line for these cases.
80+ language = None
81+
82+ # List of patterns, relative to source directory, that match files and
83+ # directories to ignore when looking for source files.
84+ # This patterns also effect to html_static_path and html_extra_path
85+ exclude_patterns = ['_build' , 'Thumbs.db' , '.DS_Store' ]
86+
87+ # The name of the Pygments (syntax highlighting) style to use.
88+ pygments_style = 'sphinx'
89+
90+ # If true, `todo` and `todoList` produce output, else they produce nothing.
91+ todo_include_todos = False
92+
93+
94+ # -- Options for HTML output -------------------------------------------
95+
96+ # The theme to use for HTML and HTML Help pages. See the documentation for
97+ # a list of builtin themes.
98+ #
99+ html_theme = 'sphinx_rtd_theme'
100+
101+ # Theme options are theme-specific and customize the look and feel of a
102+ # theme further. For a list of options available for each theme, see the
103+ # documentation.
104+ #
105+ # html_theme_options = {}
106+
107+ # Add any paths that contain custom static files (such as style sheets) here,
108+ # relative to this directory. They are copied after the builtin static files,
109+ # so a file named "default.css" will overwrite the builtin "default.css".
110+ html_static_path = ['_static' ]
111+
112+
113+ # -- Options for HTMLHelp output ---------------------------------------
114+
115+ # Output file base name for HTML help builder.
116+ htmlhelp_basename = 'obsarraydoc'
117+
118+
119+ # -- Options for LaTeX output ------------------------------------------
120+
121+ latex_elements = {
122+ # The paper size ('letterpaper' or 'a4paper').
123+ #
124+ # 'papersize': 'letterpaper',
125+
126+ # The font size ('10pt', '11pt' or '12pt').
127+ #
128+ # 'pointsize': '10pt',
129+
130+ # Additional stuff for the LaTeX preamble.
131+ #
132+ # 'preamble': '',
133+
134+ # Latex figure (float) alignment
135+ #
136+ # 'figure_align': 'htbp',
137+ }
138+
139+ # Grouping the document tree into LaTeX files. List of tuples
140+ # (source start file, target name, title, author, documentclass
141+ # [howto, manual, or own class]).
142+ latex_documents = [
143+ (master_doc , 'user_manual.tex' ,
144+ '{} Documentation' .format (project_title ),
145+ 'Sam Hunt' , 'manual' ),
146+ ]
147+
148+
149+ # -- Options for manual page output ------------------------------------
150+
151+ # One entry per manual page. List of tuples
152+ # (source start file, name, description, authors, manual section).
153+ man_pages = [
154+ (master_doc , 'obsarray' ,
155+ 'obsarray Documentation' ,
156+ [author ], 1 )
157+ ]
158+
159+
160+ # -- Options for Texinfo output ----------------------------------------
161+
162+ # Grouping the document tree into Texinfo files. List of tuples
163+ # (source start file, target name, title, author,
164+ # dir menu entry, description, category)
165+ texinfo_documents = [
166+ (master_doc , 'obsarray' ,
167+ 'obsarray Documentation' ,
168+ author ,
169+ 'obsarray' ,
170+ 'Propagating UNcertainties in PYthon' ,
171+ 'Miscellaneous' ),
172+ ]
173+
174+ """
23175
24176sys.path.insert(0, os.path.abspath(".."))
25177
@@ -209,3 +361,4 @@ def setup(app):
209361 "Miscellaneous",
210362 ),
211363]
364+ """
0 commit comments