8000 fix sphinx warnings + use readthedocs theme · zuoyanizz/python-control@469ae00 · GitHub
[go: up one dir, main page]

Skip to content

Commit 469ae00

Browse files
committed
fix sphinx warnings + use readthedocs theme
1 parent c2e9f93 commit 469ae00

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

control/statesp.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -424,8 +424,8 @@ def freqresp(self, omega):
424424
425425
G(exp(j*omega*dt)) = mag*exp(j*phase).
426426
427-
Inputs
428-
------
427+
Parameters
428+
----------
429429
omega: A list of frequencies in radians/sec at which the system
430430
should be evaluated. The list can be either a python list
431431
or a numpy array and will be sorted before evaluation.

doc-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
numpy
22
scipy
33
matplotlib
4+
sphinx_rtd_theme
45
numpydoc

doc/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@
3030
# -- Project information -----------------------------------------------------
3131

3232
project = u'Python Control Systems Library'
33-
copyright = u'2018, python-control.org'
33+
copyright = u'2019, python-control.org'
3434
author = u'Python Control Developers'
3535

3636
# Version information - read from the source code
3737
import re
3838
import control
3939

40-
# The short X.Y version
41-
version = re.sub(r'(\d+\.\d+)\.(.*)', r'\1', control.__version__)
40+
# The short X.Y.Z version
41+
version = re.sub(r'(\d+\.\d+\.\d+)(.*)', r'\1', control.__version__)
4242

4343
# The full version, including alpha/beta/rc tags
4444
release = control.__version__
@@ -109,7 +109,7 @@
109109
# The theme to use for HTML and HTML Help pages. See the documentation for
110110
# a list of builtin themes.
111111
#
112-
# html_theme = 'alabaster'
112+
html_theme = 'sphinx_rtd_theme'
113113

114114
# Theme options are theme-specific and customize the look and feel of a theme
115115
# further. For a list of options available for each theme, see the
@@ -120,7 +120,7 @@
120120
# Add any paths that contain custom static files (such as style sheets) here,
121121
# relative to this directory. They are copied after the builtin static files,
122122
# so a file named "default.css" will overwrite the builtin "default.css".
123-
html_static_path = ['_static']
123+
# html_static_path = ['_static']
124124

125125
# Custom sidebar templates, must be a dictionary that maps document names
126126
# to template names.

0 commit comments

Comments
 (0)
0