|
1 | | -# Pymodbus |
| 1 | +# -*- coding: utf-8 -*- |
2 | 2 | # |
3 | | -# Author: dhoomakethu <otlasanju@gmail.com> |
4 | | -# Last Change: May 20, 2017 |
5 | | -# URL: https://pymodbus.readthedocs.io |
6 | | - |
7 | | -"""Sphinx documentation configuration for the `pymodbus` package.""" |
| 3 | +# pymodbus documentation build configuration file, created by |
| 4 | +# sphinx-quickstart on Fri May 26 10:10:53 2017. |
| 5 | +# |
| 6 | +# This file is execfile()d with the current directory set to its |
| 7 | +# containing dir. |
| 8 | +# |
| 9 | +# Note that not all possible configuration values are present in this |
| 10 | +# autogenerated file. |
| 11 | +# |
| 12 | +# All configuration values have a default; values that are commented out |
| 13 | +# serve to show the default. |
8 | 14 |
|
| 15 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 16 | +# add these directories to sys.path here. If the directory is relative to the |
| 17 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 18 | +# |
9 | 19 | import os |
10 | 20 | import sys |
11 | 21 |
|
12 | 22 | sys.path.insert(0, os.path.abspath(os.pardir)) |
13 | 23 |
|
| 24 | +from pymodbus import __version__, __author__, __maintainer__ |
| 25 | + |
| 26 | +# -- General configuration ------------------------------------------------ |
14 | 27 |
|
15 | | -# -- General configuration ---------------------------------------------------- |
| 28 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 29 | +# |
| 30 | +# needs_sphinx = '1.0' |
16 | 31 |
|
| 32 | +# Add any Sphinx extension module names here, as strings. They can be |
| 33 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 34 | +# ones. |
17 | 35 | # Sphinx extension module names. |
18 | 36 | extensions = [ |
19 | 37 | 'sphinx.ext.autodoc', |
|
22 | 40 | 'humanfriendly.sphinx', |
23 | 41 | ] |
24 | 42 |
|
| 43 | +# Add any paths that contain templates here, relative to this directory. |
| 44 | +templates_path = ['_templates'] |
| 45 | + |
25 | 46 | # Sort members by the source order instead of alphabetically. |
26 | 47 | autodoc_member_order = 'bysource' |
27 | 48 |
|
|
36 | 57 |
|
37 | 58 | # General information about the project. |
38 | 59 | project = u'pymodbus' |
39 | | -copyright = u'2017, riptideio/bashworks' |
| 60 | +copyright = u'2017, {}, {}'.format(__author__, __maintainer__) |
| 61 | +author = u'{}, {}'.format(__author__, __maintainer__) |
40 | 62 |
|
41 | 63 | # The version info for the project you're documenting, acts as replacement for |
42 | 64 | # |version| and |release|, also used in various other places throughout the |
43 | 65 | # built documents. |
44 | | - |
45 | | -# Find the package version and make it the release. |
46 | | -from pymodbus import __version__ as pymodbus_version # noqa |
47 | | - |
| 66 | +# |
48 | 67 | # The short X.Y version. |
49 | | -version = '.'.join(pymodbus_version.split('.')[:2]) |
50 | | - |
| 68 | +version = __version__ |
51 | 69 | # The full version, including alpha/beta/rc tags. |
52 | | -release = pymodbus_version |
| 70 | +release = __version__ |
53 | 71 |
|
54 | 72 | # The language for content autogenerated by Sphinx. Refer to documentation |
55 | 73 | # for a list of supported languages. |
| 74 | +# |
| 75 | +# This is also used if you do content translation via gettext catalogs. |
| 76 | +# Usually you set "language" from the command line for these cases. |
56 | 77 | language = 'en' |
57 | 78 |
|
58 | 79 | # List of patterns, relative to source directory, that match files and |
59 | 80 | # directories to ignore when looking for source files. |
60 | | -exclude_patterns = ['build'] |
| 81 | +exclude_patterns = ['build', '_build', 'Thumbs.db', '.DS_Store'] |
61 | 82 |
|
62 | 83 | # If true, '()' will be appended to :func: etc. cross-reference text. |
63 | 84 | add_function_parentheses = True |
|
0 commit comments