A separate conf.py and doc directory (or will be needed if someone wants
to build the bindings docs separately from notmuch.
if "$python" -c 'import cffi,setuptools; cffi.FFI().verify()' >/dev/null 2>&1; then
printf "Yes.\n"
have_python3_cffi=1
if "$python" -c 'import cffi,setuptools; cffi.FFI().verify()' >/dev/null 2>&1; then
printf "Yes.\n"
have_python3_cffi=1
else
printf "No (will not install CFFI-based python bindings).\n"
fi
else
printf "No (will not install CFFI-based python bindings).\n"
fi
if [ $WITH_EMACS = "1" ]; then
printf "tags.add('WITH_EMACS')\n" >> sphinx.config
fi
if [ $WITH_EMACS = "1" ]; then
printf "tags.add('WITH_EMACS')\n" >> sphinx.config
fi
+if [ $WITH_PYTHON_DOCS = "1" ]; then
+ printf "tags.add('WITH_PYTHON')\n" >> sphinx.config
+fi
printf "rsti_dir = '%s'\n" $(realpath emacs) >> sphinx.config
# Finally, after everything configured, inform the user how to continue.
printf "rsti_dir = '%s'\n" $(realpath emacs) >> sphinx.config
# Finally, after everything configured, inform the user how to continue.
+extensions = [ 'sphinx.ext.autodoc' ]
+
# The suffix of source filenames.
source_suffix = '.rst'
# The suffix of source filenames.
source_suffix = '.rst'
with open(version_file,'r') as infile:
version=infile.read().replace('\n','')
with open(version_file,'r') as infile:
version=infile.read().replace('\n','')
+# for autodoc
+sys.path.insert(0, os.path.join(location, '..', 'bindings', 'python-cffi', 'notmuch2'))
+
# read generated config
for pathdir in ['.', '..']:
conf_file = os.path.join(location,pathdir,'sphinx.config')
# read generated config
for pathdir in ['.', '..']:
conf_file = os.path.join(location,pathdir,'sphinx.config')
# the docstring include files
exclude_patterns.append('notmuch-emacs.rst')
# the docstring include files
exclude_patterns.append('notmuch-emacs.rst')
+if not tags.has('WITH_PYTHON'):
+ exclude_patterns.append('python-bindings.rst')
+
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
man7/notmuch-search-terms
man1/notmuch-show
man1/notmuch-tag
man7/notmuch-search-terms
man1/notmuch-show
man1/notmuch-tag
Indices and tables
==================
Indices and tables
==================
--- /dev/null
+Python Bindings
+===============
+
+.. automodule:: notmuch2
+ :members: