Skip to content

Commit 076b258

Browse files
committed
Readthedocs fix.
1 parent 5c0a4d3 commit 076b258

File tree

3 files changed

+16
-25
lines changed

3 files changed

+16
-25
lines changed

docs/.readthedocs.yaml renamed to .readthedocs.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ sphinx:
1010

1111
python:
1212
install:
13+
- path: .
1314
- requirements: docs/requirements.txt

docs/conf.py

+9-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
from simple_rpc import _get_metadata
1+
from importlib.metadata import metadata
22

33

4-
author = _get_metadata('Author')
5-
copyright = _get_metadata('Author')
6-
project = _get_metadata('Name')
7-
release = _get_metadata('Version')
4+
_package_metadata = metadata('arduino_simple_rpc')
5+
6+
author = _package_metadata['Author']
7+
copyright = '2019, {}'.format(author)
8+
project = _package_metadata['Name']
9+
release = _package_metadata['Version']
810

911
autoclass_content = 'both'
10-
extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints', 'sphinxarg.ext']
12+
extensions = [
13+
'sphinx.ext.autodoc', 'sphinx_autodoc_typehints', 'sphinxarg.ext']
1114
master_doc = 'index'

simple_rpc/__init__.py

+6-19
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,13 @@
1-
from pkg_resources import DistributionNotFound, get_distribution
1+
from importlib.metadata import metadata
22

33
from .extras import dict_to_object, object_to_dict
44
from .simple_rpc import Interface, SerialInterface, SocketInterface
55

66

7-
def _get_metadata(name: str) -> str:
8-
try:
9-
pkg = get_distribution('arduino_simple_rpc')
10-
except DistributionNotFound:
11-
pkg = get_distribution('simple_rpc')
12-
13-
for line in pkg.get_metadata_lines(pkg.PKG_INFO):
14-
if line.startswith('{}: '.format(name)):
15-
return line.split(': ')[1]
16-
17-
return ''
18-
19-
7+
_package_metadata = metadata('arduino_simple_rpc')
208
_copyright_notice = 'Copyright (c) {} <{}>'.format(
21-
_get_metadata('Author'), _get_metadata('Author-email'))
22-
23-
usage = [_get_metadata('Summary'), _copyright_notice]
9+
_package_metadata['Author'], _package_metadata['Author-email'])
10+
usage = [_package_metadata['Summary'], _copyright_notice]
2411

2512

2613
def doc_split(func: callable) -> str:
@@ -29,5 +16,5 @@ def doc_split(func: callable) -> str:
2916

3017
def version(name: str) -> str:
3118
return '{} version {}\n\n{}\nHomepage: {}'.format(
32-
_get_metadata('Name'), _get_metadata('Version'), _copyright_notice,
33-
_get_metadata('Home-page'))
19+
_package_metadata['Name'], _package_metadata['Version'],
20+
_copyright_notice, _package_metadata['Home-page'])

0 commit comments

Comments
 (0)