Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Commit

Permalink
Merge pull request #305 from lzpap/sphinx_async
Browse files Browse the repository at this point in the history
Configure sphinx to render coroutines in docs
  • Loading branch information
lzpap committed Feb 20, 2020
2 parents c7a95e2 + 1aacb70 commit 35f0a1f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel']
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
'sphinxcontrib.asyncio',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -47,7 +51,7 @@

# General information about the project.
project = 'PyOTA'
copyright = '2019, Phoenix Zerin & Levente Pap'
copyright = '2020, Phoenix Zerin & Levente Pap'
author = 'Phoenix Zerin, Levente Pap'

# The version info for the project you're documenting, acts as replacement for
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@

extras_require={
'ccurl': ['pyota-ccurl'],
'docs-builder': ['sphinx', 'sphinx_rtd_theme'],
'docs-builder': ['sphinx', 'sphinx_rtd_theme', 'sphinxcontrib-asyncio'],
'pow': ['pyota-pow >= 1.0.2'],
# tox is able to run the tests in parallel since version 3.7
'test-runner': ['tox >= 3.7'] + tests_require,
Expand Down

0 comments on commit 35f0a1f

Please sign in to comment.