Skip to content

Generate RST documentation using sphinx autodoc extension without recompiling C extension code #837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft

Generate RST documentation using sphinx autodoc extension without recompiling C extension code #837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions doc/aerospike.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
Overview
========

.. module:: aerospike
:platform: 64-bit Linux and OS X
:synopsis: Aerospike client for Python.
.. automodule:: aerospike

``aerospike`` is a package which provides a Python client for Aerospike database clusters.

Expand Down
5 changes: 3 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def __getattr__(cls, name):
return MagicMock()


sys.modules.update({"aerospike": Mock()})
# sys.modules.update({"aerospike": Mock()})

# sys.path.append(os.path.abspath('/usr/local/lib/python2.7/site-packages/aerospike-1.0.44-py2.7-macosx-10.9-x86_64.egg/'))

Expand All @@ -39,7 +39,8 @@ def __getattr__(cls, name):
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.napoleon",
"sphinxcontrib.spelling"
"sphinxcontrib.spelling",
"sphinx.ext.autosummary"
]
napoleon_google_docstring = True
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
Expand Down
Loading