diff options
author | Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> | 2020-06-09 10:57:48 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-06-09 10:57:48 -0700 |
commit | 945bafc47cfaf79f0947c970dba17dc8fbe3e197 (patch) | |
tree | 2c78b04f66a366abceb8a5e3a546cc5ffdab31f1 /docs | |
parent | 8212bb7f54ca08a498faddaca513580a1f890dbd (diff) | |
download | python-api-core-945bafc47cfaf79f0947c970dba17dc8fbe3e197.tar.gz |
chore: update templates (#44)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 5 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/multiprocessing.rst | 7 |
3 files changed, 10 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 6efe6dd..dd92a74 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,6 +38,7 @@ extensions = [ "sphinx.ext.napoleon", "sphinx.ext.todo", "sphinx.ext.viewcode", + "recommonmark", ] # autodoc/autosummary flags @@ -49,10 +50,6 @@ autosummary_generate = True # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] diff --git a/docs/index.rst b/docs/index.rst index 67572a0..858e889 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,8 @@ The ``google-cloud-core`` package contains helpers common to all much of the functionality has been split out into this package, ``google-api-core``. +.. include:: multiprocessing.rst + Core ==== diff --git a/docs/multiprocessing.rst b/docs/multiprocessing.rst new file mode 100644 index 0000000..1cb29d4 --- /dev/null +++ b/docs/multiprocessing.rst @@ -0,0 +1,7 @@ +.. note:: + + Because this client uses :mod:`grpcio` library, it is safe to + share instances across threads. In multiprocessing scenarios, the best + practice is to create client instances *after* the invocation of + :func:`os.fork` by :class:`multiprocessing.Pool` or + :class:`multiprocessing.Process`. |