Skip to content

Commit 4721619

Browse files
author
Chaitanya CHINTALURI
committed
fixing docstring autogeneration related errors
1 parent 9727ed2 commit 4721619

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

docs/source/conf.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@
1717
# add these directories to sys.path here. If the directory is relative to the
1818
# documentation root, use os.path.abspath to make it absolute, like shown here.
1919
#
20-
# import os
21-
# import sys
22-
# sys.path.insert(0, os.path.abspath('.'))
20+
import os
21+
import sys
22+
sys.path.insert(0, os.path.abspath('.'))
23+
sys.path.insert(0, os.path.abspath('../../'))
2324

2425

2526
# -- General configuration ------------------------------------------------
@@ -69,7 +70,7 @@
6970
#
7071
# This is also used if you do content translation via gettext catalogs.
7172
# Usually you set "language" from the command line for these cases.
72-
language = None
73+
language = 'en'
7374

7475
# List of patterns, relative to source directory, that match files and
7576
# directories to ignore when looking for source files.
@@ -99,7 +100,8 @@
99100
# Add any paths that contain custom static files (such as style sheets) here,
100101
# relative to this directory. They are copied after the builtin static files,
101102
# so a file named "default.css" will overwrite the builtin "default.css".
102-
html_static_path = ['_static']
103+
# html_static_path = ['_static']
104+
html_static_path = []
103105

104106
# Custom sidebar templates, must be a dictionary that maps document names
105107
# to template names.
@@ -147,8 +149,11 @@
147149
# (source start file, target name, title,
148150
# author, documentclass [howto, manual, or own class]).
149151
latex_documents = [
150-
(master_doc, 'kCSD-python.tex', 'kCSD-python Documentation',
151-
'Chintaluri et.al.', 'manual'),
152+
(master_doc,
153+
'kCSD-python.tex',
154+
'kCSD-python Documentation',
155+
'Chintaluri et al.',
156+
'manual'),
152157
]
153158

154159

docs/source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Requirements for building documentation
22
scipy
33
numpy
4+
matplotlib
45
numpydoc
56
sphinx
67

0 commit comments

Comments
 (0)