From 1b600f69e7b278ac0f0e2e95a12ba5c917da7fb9 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 12:47:13 +0800 Subject: [PATCH 01/17] feat: add readthedocs conf --- .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..aa209bb2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,32 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt From a4a00dc30f9954c4f261e570dbd8265801c4c1e0 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 12:53:58 +0800 Subject: [PATCH 02/17] chore: update readthedocs conf --- .readthedocs.yaml | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index aa209bb2..9fbae286 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,31 +2,23 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 -# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py # Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub +formats: + - pdf + - epub -# Optional but recommended, declare the Python requirements required -# to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: docs/requirements.txt From 7e9a68de37606bacdf604948c978af4185baf3b5 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 12:57:04 +0800 Subject: [PATCH 03/17] feat: add requirements.txt for docs build --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..0a4fb42e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx==7.2.6 +furo==2023.9.10 From b9019537f2f9528c8a7fdcb678dfd0a0003eb84f Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 13:05:21 +0800 Subject: [PATCH 04/17] fix: source conf path --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9fbae286..a9d149c8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py # Optionally build your docs in additional formats such as PDF and ePub formats: From fc3606be555aacd06c75058c46af136499afd0f1 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 13:49:01 +0800 Subject: [PATCH 05/17] fix: sys path --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index a5508794..9cde8bb8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,7 +5,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 8043efcf1b6e74a0a7b48c8bd866523fd5db9ec1 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 13:54:41 +0800 Subject: [PATCH 06/17] fix: sys path --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9cde8bb8..d7cffffa 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,7 +5,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../nebula3')) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 44a1c7a77118d9a4deec331e892db705c55d4b9e Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 14:02:26 +0800 Subject: [PATCH 07/17] fix --- docs/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d7cffffa..b8d7b987 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,7 +5,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('../../nebula3')) +# sys.path.insert(0, os.path.abspath('../..')) +sys.path.append(os.path.join(os.path.dirname(__name__), '../..')) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 7779de3e3e393d548a7de1cfa768755a269f053b Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 14:07:59 +0800 Subject: [PATCH 08/17] fix --- docs/source/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index b8d7b987..d6b699c1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,8 +5,10 @@ import os import sys -# sys.path.insert(0, os.path.abspath('../..')) -sys.path.append(os.path.join(os.path.dirname(__name__), '../..')) +sys.path.insert(0, os.path.abspath('../..')) +sys.path.append(os.path.abspath( + os.path.join(__file__, '../../../nebula3') +)) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 72f22552e9d3f1d6d246d56ae85e23b20555be52 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 14:10:20 +0800 Subject: [PATCH 09/17] fix --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d6b699c1..b903cb4e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -7,7 +7,7 @@ sys.path.insert(0, os.path.abspath('../..')) sys.path.append(os.path.abspath( - os.path.join(__file__, '../../../nebula3') + os.path.join(__file__, '../../../nebula3/gclient') )) # -- Project information ----------------------------------------------------- From 2db64be9e136247a5128df06c52373e85757fcc8 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 14:49:55 +0800 Subject: [PATCH 10/17] fix --- docs/source/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index b903cb4e..9cde8bb8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -6,9 +6,6 @@ import sys sys.path.insert(0, os.path.abspath('../..')) -sys.path.append(os.path.abspath( - os.path.join(__file__, '../../../nebula3/gclient') -)) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 9cc8b1404539ceef8455075c8c0f8138c5e0adda Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 15:12:52 +0800 Subject: [PATCH 11/17] fix --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 0a4fb42e..9abcf6cc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ sphinx==7.2.6 furo==2023.9.10 +six==1.16.0 From 65bd83cd0baf06d3305c51a7a2e8a2352e161893 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 15:27:27 +0800 Subject: [PATCH 12/17] fix --- .readthedocs.yaml | 5 ----- docs/requirements.txt | 1 + 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a9d149c8..1c297521 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,11 +13,6 @@ build: sphinx: configuration: docs/source/conf.py -# Optionally build your docs in additional formats such as PDF and ePub -formats: - - pdf - - epub - # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: diff --git a/docs/requirements.txt b/docs/requirements.txt index 9abcf6cc..892f1743 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ sphinx==7.2.6 furo==2023.9.10 six==1.16.0 +pytz==2023.3.post1 From 1619042bd85ee3d552cea2d6bebb26fb8a848f39 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 15:44:15 +0800 Subject: [PATCH 13/17] feat: publish --- docs/build.sh | 0 docs/requirements.txt | 2 - docs/source/_autosummary/nebula3.gclient.rst | 23 ++++ docs/source/modules.rst | 7 + docs/source/nebula3.common.rst | 29 ++++ docs/source/nebula3.data.rst | 29 ++++ docs/source/nebula3.fbthrift.protocol.rst | 85 ++++++++++++ docs/source/nebula3.fbthrift.rst | 48 +++++++ docs/source/nebula3.fbthrift.server.rst | 37 ++++++ docs/source/nebula3.fbthrift.transport.rst | 77 +++++++++++ docs/source/nebula3.fbthrift.util.rst | 133 +++++++++++++++++++ docs/source/nebula3.gclient.net.rst | 53 ++++++++ docs/source/nebula3.gclient.rst | 18 +++ docs/source/nebula3.graph.rst | 37 ++++++ docs/source/nebula3.mclient.rst | 10 ++ docs/source/nebula3.meta.rst | 37 ++++++ docs/source/nebula3.rst | 53 ++++++++ docs/source/nebula3.sclient.net.rst | 10 ++ docs/source/nebula3.sclient.rst | 45 +++++++ docs/source/nebula3.storage.rst | 45 +++++++ 20 files changed, 776 insertions(+), 2 deletions(-) mode change 100644 => 100755 docs/build.sh create mode 100644 docs/source/_autosummary/nebula3.gclient.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/nebula3.common.rst create mode 100644 docs/source/nebula3.data.rst create mode 100644 docs/source/nebula3.fbthrift.protocol.rst create mode 100644 docs/source/nebula3.fbthrift.rst create mode 100644 docs/source/nebula3.fbthrift.server.rst create mode 100644 docs/source/nebula3.fbthrift.transport.rst create mode 100644 docs/source/nebula3.fbthrift.util.rst create mode 100644 docs/source/nebula3.gclient.net.rst create mode 100644 docs/source/nebula3.gclient.rst create mode 100644 docs/source/nebula3.graph.rst create mode 100644 docs/source/nebula3.mclient.rst create mode 100644 docs/source/nebula3.meta.rst create mode 100644 docs/source/nebula3.rst create mode 100644 docs/source/nebula3.sclient.net.rst create mode 100644 docs/source/nebula3.sclient.rst create mode 100644 docs/source/nebula3.storage.rst diff --git a/docs/build.sh b/docs/build.sh old mode 100644 new mode 100755 diff --git a/docs/requirements.txt b/docs/requirements.txt index 892f1743..0a4fb42e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,2 @@ sphinx==7.2.6 furo==2023.9.10 -six==1.16.0 -pytz==2023.3.post1 diff --git a/docs/source/_autosummary/nebula3.gclient.rst b/docs/source/_autosummary/nebula3.gclient.rst new file mode 100644 index 00000000..fd914a8a --- /dev/null +++ b/docs/source/_autosummary/nebula3.gclient.rst @@ -0,0 +1,23 @@ +nebula3.gclient +=============== + +.. automodule:: nebula3.gclient + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..a8633a7f --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +nebula3 +======= + +.. toctree:: + :maxdepth: 4 + + nebula3 diff --git a/docs/source/nebula3.common.rst b/docs/source/nebula3.common.rst new file mode 100644 index 00000000..9d5d33e4 --- /dev/null +++ b/docs/source/nebula3.common.rst @@ -0,0 +1,29 @@ +nebula3.common package +====================== + +Submodules +---------- + +nebula3.common.constants module +------------------------------- + +.. automodule:: nebula3.common.constants + :members: + :undoc-members: + :show-inheritance: + +nebula3.common.ttypes module +---------------------------- + +.. automodule:: nebula3.common.ttypes + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.common + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.data.rst b/docs/source/nebula3.data.rst new file mode 100644 index 00000000..845edc75 --- /dev/null +++ b/docs/source/nebula3.data.rst @@ -0,0 +1,29 @@ +nebula3.data package +==================== + +Submodules +---------- + +nebula3.data.DataObject module +------------------------------ + +.. automodule:: nebula3.data.DataObject + :members: + :undoc-members: + :show-inheritance: + +nebula3.data.ResultSet module +----------------------------- + +.. automodule:: nebula3.data.ResultSet + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.data + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.protocol.rst b/docs/source/nebula3.fbthrift.protocol.rst new file mode 100644 index 00000000..6c2c062b --- /dev/null +++ b/docs/source/nebula3.fbthrift.protocol.rst @@ -0,0 +1,85 @@ +nebula3.fbthrift.protocol package +================================= + +Submodules +---------- + +nebula3.fbthrift.protocol.TBinaryProtocol module +------------------------------------------------ + +.. automodule:: nebula3.fbthrift.protocol.TBinaryProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TCompactProtocol module +------------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.TCompactProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.THeaderProtocol module +------------------------------------------------ + +.. automodule:: nebula3.fbthrift.protocol.THeaderProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TJSONProtocol module +---------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.TJSONProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TMultiplexedProtocol module +----------------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.TMultiplexedProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TProtocol module +------------------------------------------ + +.. automodule:: nebula3.fbthrift.protocol.TProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TProtocolDecorator module +--------------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.TProtocolDecorator + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.TSimpleJSONProtocol module +---------------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.TSimpleJSONProtocol + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.protocol.exceptions module +------------------------------------------- + +.. automodule:: nebula3.fbthrift.protocol.exceptions + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.fbthrift.protocol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.rst b/docs/source/nebula3.fbthrift.rst new file mode 100644 index 00000000..c900519b --- /dev/null +++ b/docs/source/nebula3.fbthrift.rst @@ -0,0 +1,48 @@ +nebula3.fbthrift package +======================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nebula3.fbthrift.protocol + nebula3.fbthrift.server + nebula3.fbthrift.transport + nebula3.fbthrift.util + +Submodules +---------- + +nebula3.fbthrift.TMultiplexedProcessor module +--------------------------------------------- + +.. automodule:: nebula3.fbthrift.TMultiplexedProcessor + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.TSCons module +------------------------------ + +.. automodule:: nebula3.fbthrift.TSCons + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.Thrift module +------------------------------ + +.. automodule:: nebula3.fbthrift.Thrift + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.fbthrift + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.server.rst b/docs/source/nebula3.fbthrift.server.rst new file mode 100644 index 00000000..65a3639d --- /dev/null +++ b/docs/source/nebula3.fbthrift.server.rst @@ -0,0 +1,37 @@ +nebula3.fbthrift.server package +=============================== + +Submodules +---------- + +nebula3.fbthrift.server.TAsyncioServer module +--------------------------------------------- + +.. automodule:: nebula3.fbthrift.server.TAsyncioServer + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.server.TCppServer module +----------------------------------------- + +.. automodule:: nebula3.fbthrift.server.TCppServer + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.server.TServer module +-------------------------------------- + +.. automodule:: nebula3.fbthrift.server.TServer + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.fbthrift.server + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.transport.rst b/docs/source/nebula3.fbthrift.transport.rst new file mode 100644 index 00000000..a9bc591a --- /dev/null +++ b/docs/source/nebula3.fbthrift.transport.rst @@ -0,0 +1,77 @@ +nebula3.fbthrift.transport package +================================== + +Submodules +---------- + +nebula3.fbthrift.transport.THeaderTransport module +-------------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.THeaderTransport + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.THttpClient module +--------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.THttpClient + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TSSLSocket module +-------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TSSLSocket + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TSSLSocketOverHttpTunnel module +---------------------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TSSLSocketOverHttpTunnel + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TSocket module +----------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TSocket + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TSocketOverHttpTunnel module +------------------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TSocketOverHttpTunnel + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TSocketTest module +--------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TSocketTest + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.transport.TTransport module +-------------------------------------------- + +.. automodule:: nebula3.fbthrift.transport.TTransport + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.fbthrift.transport + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.util.rst b/docs/source/nebula3.fbthrift.util.rst new file mode 100644 index 00000000..0a5e727f --- /dev/null +++ b/docs/source/nebula3.fbthrift.util.rst @@ -0,0 +1,133 @@ +nebula3.fbthrift.util package +============================= + +Submodules +---------- + +nebula3.fbthrift.util.BytesStrIO module +--------------------------------------- + +.. automodule:: nebula3.fbthrift.util.BytesStrIO + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.Decorators module +--------------------------------------- + +.. automodule:: nebula3.fbthrift.util.Decorators + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.Recursive module +-------------------------------------- + +.. automodule:: nebula3.fbthrift.util.Recursive + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.Serializer module +--------------------------------------- + +.. automodule:: nebula3.fbthrift.util.Serializer + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.TCppServerTestManager module +-------------------------------------------------- + +.. automodule:: nebula3.fbthrift.util.TCppServerTestManager + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.TCppServerTestManagerTest module +------------------------------------------------------ + +.. automodule:: nebula3.fbthrift.util.TCppServerTestManagerTest + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.TValidator module +--------------------------------------- + +.. automodule:: nebula3.fbthrift.util.TValidator + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.async\_common module +------------------------------------------ + +.. automodule:: nebula3.fbthrift.util.async_common + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.asyncio module +------------------------------------ + +.. automodule:: nebula3.fbthrift.util.asyncio + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.converter module +-------------------------------------- + +.. automodule:: nebula3.fbthrift.util.converter + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.fuzzer module +----------------------------------- + +.. automodule:: nebula3.fbthrift.util.fuzzer + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.inspect module +------------------------------------ + +.. automodule:: nebula3.fbthrift.util.inspect + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.randomizer module +--------------------------------------- + +.. automodule:: nebula3.fbthrift.util.randomizer + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.remote module +----------------------------------- + +.. automodule:: nebula3.fbthrift.util.remote + :members: + :undoc-members: + :show-inheritance: + +nebula3.fbthrift.util.type\_inspect module +------------------------------------------ + +.. automodule:: nebula3.fbthrift.util.type_inspect + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.fbthrift.util + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.gclient.net.rst b/docs/source/nebula3.gclient.net.rst new file mode 100644 index 00000000..3766ae70 --- /dev/null +++ b/docs/source/nebula3.gclient.net.rst @@ -0,0 +1,53 @@ +nebula3.gclient.net package +=========================== + +Submodules +---------- + +nebula3.gclient.net.AuthResult module +------------------------------------- + +.. automodule:: nebula3.gclient.net.AuthResult + :members: + :undoc-members: + :show-inheritance: + +nebula3.gclient.net.Connection module +------------------------------------- + +.. automodule:: nebula3.gclient.net.Connection + :members: + :undoc-members: + :show-inheritance: + +nebula3.gclient.net.ConnectionPool module +----------------------------------------- + +.. automodule:: nebula3.gclient.net.ConnectionPool + :members: + :undoc-members: + :show-inheritance: + +nebula3.gclient.net.Session module +---------------------------------- + +.. automodule:: nebula3.gclient.net.Session + :members: + :undoc-members: + :show-inheritance: + +nebula3.gclient.net.SessionPool module +-------------------------------------- + +.. automodule:: nebula3.gclient.net.SessionPool + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.gclient.net + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.gclient.rst b/docs/source/nebula3.gclient.rst new file mode 100644 index 00000000..626fa9ea --- /dev/null +++ b/docs/source/nebula3.gclient.rst @@ -0,0 +1,18 @@ +nebula3.gclient package +======================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nebula3.gclient.net + +Module contents +--------------- + +.. automodule:: nebula3.gclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.graph.rst b/docs/source/nebula3.graph.rst new file mode 100644 index 00000000..15ac9a20 --- /dev/null +++ b/docs/source/nebula3.graph.rst @@ -0,0 +1,37 @@ +nebula3.graph package +===================== + +Submodules +---------- + +nebula3.graph.GraphService module +--------------------------------- + +.. automodule:: nebula3.graph.GraphService + :members: + :undoc-members: + :show-inheritance: + +nebula3.graph.constants module +------------------------------ + +.. automodule:: nebula3.graph.constants + :members: + :undoc-members: + :show-inheritance: + +nebula3.graph.ttypes module +--------------------------- + +.. automodule:: nebula3.graph.ttypes + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.graph + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.mclient.rst b/docs/source/nebula3.mclient.rst new file mode 100644 index 00000000..08870d4f --- /dev/null +++ b/docs/source/nebula3.mclient.rst @@ -0,0 +1,10 @@ +nebula3.mclient package +======================= + +Module contents +--------------- + +.. automodule:: nebula3.mclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.meta.rst b/docs/source/nebula3.meta.rst new file mode 100644 index 00000000..28857151 --- /dev/null +++ b/docs/source/nebula3.meta.rst @@ -0,0 +1,37 @@ +nebula3.meta package +==================== + +Submodules +---------- + +nebula3.meta.MetaService module +------------------------------- + +.. automodule:: nebula3.meta.MetaService + :members: + :undoc-members: + :show-inheritance: + +nebula3.meta.constants module +----------------------------- + +.. automodule:: nebula3.meta.constants + :members: + :undoc-members: + :show-inheritance: + +nebula3.meta.ttypes module +-------------------------- + +.. automodule:: nebula3.meta.ttypes + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.meta + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.rst b/docs/source/nebula3.rst new file mode 100644 index 00000000..fb4c7481 --- /dev/null +++ b/docs/source/nebula3.rst @@ -0,0 +1,53 @@ +nebula3 package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nebula3.common + nebula3.data + nebula3.fbthrift + nebula3.gclient + nebula3.graph + nebula3.mclient + nebula3.meta + nebula3.sclient + nebula3.storage + +Submodules +---------- + +nebula3.Config module +--------------------- + +.. automodule:: nebula3.Config + :members: + :undoc-members: + :show-inheritance: + +nebula3.Exception module +------------------------ + +.. automodule:: nebula3.Exception + :members: + :undoc-members: + :show-inheritance: + +nebula3.logger module +--------------------- + +.. automodule:: nebula3.logger + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.sclient.net.rst b/docs/source/nebula3.sclient.net.rst new file mode 100644 index 00000000..957916e1 --- /dev/null +++ b/docs/source/nebula3.sclient.net.rst @@ -0,0 +1,10 @@ +nebula3.sclient.net package +=========================== + +Module contents +--------------- + +.. automodule:: nebula3.sclient.net + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.sclient.rst b/docs/source/nebula3.sclient.rst new file mode 100644 index 00000000..f0eecb91 --- /dev/null +++ b/docs/source/nebula3.sclient.rst @@ -0,0 +1,45 @@ +nebula3.sclient package +======================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nebula3.sclient.net + +Submodules +---------- + +nebula3.sclient.BaseResult module +--------------------------------- + +.. automodule:: nebula3.sclient.BaseResult + :members: + :undoc-members: + :show-inheritance: + +nebula3.sclient.GraphStorageClient module +----------------------------------------- + +.. automodule:: nebula3.sclient.GraphStorageClient + :members: + :undoc-members: + :show-inheritance: + +nebula3.sclient.ScanResult module +--------------------------------- + +.. automodule:: nebula3.sclient.ScanResult + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.sclient + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nebula3.storage.rst b/docs/source/nebula3.storage.rst new file mode 100644 index 00000000..9a9363be --- /dev/null +++ b/docs/source/nebula3.storage.rst @@ -0,0 +1,45 @@ +nebula3.storage package +======================= + +Submodules +---------- + +nebula3.storage.GraphStorageService module +------------------------------------------ + +.. automodule:: nebula3.storage.GraphStorageService + :members: + :undoc-members: + :show-inheritance: + +nebula3.storage.StorageAdminService module +------------------------------------------ + +.. automodule:: nebula3.storage.StorageAdminService + :members: + :undoc-members: + :show-inheritance: + +nebula3.storage.constants module +-------------------------------- + +.. automodule:: nebula3.storage.constants + :members: + :undoc-members: + :show-inheritance: + +nebula3.storage.ttypes module +----------------------------- + +.. automodule:: nebula3.storage.ttypes + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: nebula3.storage + :members: + :undoc-members: + :show-inheritance: From b29769daec4570c7078afd6ce0344ccb2ce6014c Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 15:47:52 +0800 Subject: [PATCH 14/17] fix: add dep --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 0a4fb42e..892f1743 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,4 @@ sphinx==7.2.6 furo==2023.9.10 +six==1.16.0 +pytz==2023.3.post1 From 06a9ba6b3ffe0d2f23a2b81b227df58fd3686f84 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 15:57:51 +0800 Subject: [PATCH 15/17] feat: add preview CI --- .github/workflows/pull-request-links.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/pull-request-links.yaml diff --git a/.github/workflows/pull-request-links.yaml b/.github/workflows/pull-request-links.yaml new file mode 100644 index 00000000..a630109a --- /dev/null +++ b/.github/workflows/pull-request-links.yaml @@ -0,0 +1,22 @@ +# .github/workflows/pull-request-links.yaml + +name: readthedocs/actions +on: + pull_request_target: + types: + - opened + # Execute this action only on PRs that touch + # documentation files. + paths: + - "docs/**" + +permissions: + pull-requests: write + +jobs: + pull-request-links: + runs-on: ubuntu-latest + steps: + - uses: readthedocs/actions/preview@v1 + with: + project-slug: "liuxiaocs-nebula-python" From 0725358e3093c2e860dd63e5b9fd754b3a42d3f5 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Mon, 2 Oct 2023 16:14:13 +0800 Subject: [PATCH 16/17] update --- .github/workflows/pull-request-links.yaml | 2 +- docs/source/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/pull-request-links.yaml b/.github/workflows/pull-request-links.yaml index a630109a..f6717b94 100644 --- a/.github/workflows/pull-request-links.yaml +++ b/.github/workflows/pull-request-links.yaml @@ -19,4 +19,4 @@ jobs: steps: - uses: readthedocs/actions/preview@v1 with: - project-slug: "liuxiaocs-nebula-python" + project-slug: "nebula-python" diff --git a/docs/source/conf.py b/docs/source/conf.py index 9cde8bb8..a5508794 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -5,7 +5,7 @@ import os import sys -sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../')) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information From 244da0780d16db918373ff323a9a25dfed622e05 Mon Sep 17 00:00:00 2001 From: liuxiao Date: Sun, 15 Oct 2023 21:01:51 +0800 Subject: [PATCH 17/17] exclude --- docs/build.sh | 10 +- docs/source/nebula3.common.rst | 29 ----- docs/source/nebula3.data.rst | 29 ----- docs/source/nebula3.fbthrift.protocol.rst | 85 ------------- docs/source/nebula3.fbthrift.rst | 48 -------- docs/source/nebula3.fbthrift.server.rst | 37 ------ docs/source/nebula3.fbthrift.transport.rst | 77 ------------ docs/source/nebula3.fbthrift.util.rst | 133 --------------------- docs/source/nebula3.graph.rst | 37 ------ docs/source/nebula3.mclient.rst | 10 -- docs/source/nebula3.meta.rst | 37 ------ docs/source/nebula3.rst | 8 -- docs/source/nebula3.sclient.net.rst | 10 -- docs/source/nebula3.sclient.rst | 45 ------- docs/source/nebula3.storage.rst | 45 ------- 15 files changed, 9 insertions(+), 631 deletions(-) delete mode 100644 docs/source/nebula3.common.rst delete mode 100644 docs/source/nebula3.data.rst delete mode 100644 docs/source/nebula3.fbthrift.protocol.rst delete mode 100644 docs/source/nebula3.fbthrift.rst delete mode 100644 docs/source/nebula3.fbthrift.server.rst delete mode 100644 docs/source/nebula3.fbthrift.transport.rst delete mode 100644 docs/source/nebula3.fbthrift.util.rst delete mode 100644 docs/source/nebula3.graph.rst delete mode 100644 docs/source/nebula3.mclient.rst delete mode 100644 docs/source/nebula3.meta.rst delete mode 100644 docs/source/nebula3.sclient.net.rst delete mode 100644 docs/source/nebula3.sclient.rst delete mode 100644 docs/source/nebula3.storage.rst diff --git a/docs/build.sh b/docs/build.sh index db6584f2..ee499116 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -1,4 +1,12 @@ pip install --user sphinx furo -sphinx-apidoc -o source ../nebula3 +sphinx-apidoc -f -o source ../nebula3 \ + ../nebula3/common/* \ + ../nebula3/data/* \ + ../nebula3/fbthrift/* \ + ../nebula3/graph/* \ + ../nebula3/mclient/* \ + ../nebula3/meta/* \ + ../nebula3/sclient/* \ + ../nebula3/storage/* make clean make html diff --git a/docs/source/nebula3.common.rst b/docs/source/nebula3.common.rst deleted file mode 100644 index 9d5d33e4..00000000 --- a/docs/source/nebula3.common.rst +++ /dev/null @@ -1,29 +0,0 @@ -nebula3.common package -====================== - -Submodules ----------- - -nebula3.common.constants module -------------------------------- - -.. automodule:: nebula3.common.constants - :members: - :undoc-members: - :show-inheritance: - -nebula3.common.ttypes module ----------------------------- - -.. automodule:: nebula3.common.ttypes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.common - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.data.rst b/docs/source/nebula3.data.rst deleted file mode 100644 index 845edc75..00000000 --- a/docs/source/nebula3.data.rst +++ /dev/null @@ -1,29 +0,0 @@ -nebula3.data package -==================== - -Submodules ----------- - -nebula3.data.DataObject module ------------------------------- - -.. automodule:: nebula3.data.DataObject - :members: - :undoc-members: - :show-inheritance: - -nebula3.data.ResultSet module ------------------------------ - -.. automodule:: nebula3.data.ResultSet - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.data - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.protocol.rst b/docs/source/nebula3.fbthrift.protocol.rst deleted file mode 100644 index 6c2c062b..00000000 --- a/docs/source/nebula3.fbthrift.protocol.rst +++ /dev/null @@ -1,85 +0,0 @@ -nebula3.fbthrift.protocol package -================================= - -Submodules ----------- - -nebula3.fbthrift.protocol.TBinaryProtocol module ------------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TBinaryProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TCompactProtocol module -------------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TCompactProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.THeaderProtocol module ------------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.THeaderProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TJSONProtocol module ----------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TJSONProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TMultiplexedProtocol module ------------------------------------------------------ - -.. automodule:: nebula3.fbthrift.protocol.TMultiplexedProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TProtocol module ------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TProtocolDecorator module ---------------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TProtocolDecorator - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.TSimpleJSONProtocol module ----------------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.TSimpleJSONProtocol - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.protocol.exceptions module -------------------------------------------- - -.. automodule:: nebula3.fbthrift.protocol.exceptions - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.fbthrift.protocol - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.rst b/docs/source/nebula3.fbthrift.rst deleted file mode 100644 index c900519b..00000000 --- a/docs/source/nebula3.fbthrift.rst +++ /dev/null @@ -1,48 +0,0 @@ -nebula3.fbthrift package -======================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nebula3.fbthrift.protocol - nebula3.fbthrift.server - nebula3.fbthrift.transport - nebula3.fbthrift.util - -Submodules ----------- - -nebula3.fbthrift.TMultiplexedProcessor module ---------------------------------------------- - -.. automodule:: nebula3.fbthrift.TMultiplexedProcessor - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.TSCons module ------------------------------- - -.. automodule:: nebula3.fbthrift.TSCons - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.Thrift module ------------------------------- - -.. automodule:: nebula3.fbthrift.Thrift - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.fbthrift - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.server.rst b/docs/source/nebula3.fbthrift.server.rst deleted file mode 100644 index 65a3639d..00000000 --- a/docs/source/nebula3.fbthrift.server.rst +++ /dev/null @@ -1,37 +0,0 @@ -nebula3.fbthrift.server package -=============================== - -Submodules ----------- - -nebula3.fbthrift.server.TAsyncioServer module ---------------------------------------------- - -.. automodule:: nebula3.fbthrift.server.TAsyncioServer - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.server.TCppServer module ------------------------------------------ - -.. automodule:: nebula3.fbthrift.server.TCppServer - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.server.TServer module --------------------------------------- - -.. automodule:: nebula3.fbthrift.server.TServer - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.fbthrift.server - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.transport.rst b/docs/source/nebula3.fbthrift.transport.rst deleted file mode 100644 index a9bc591a..00000000 --- a/docs/source/nebula3.fbthrift.transport.rst +++ /dev/null @@ -1,77 +0,0 @@ -nebula3.fbthrift.transport package -================================== - -Submodules ----------- - -nebula3.fbthrift.transport.THeaderTransport module --------------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.THeaderTransport - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.THttpClient module ---------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.THttpClient - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TSSLSocket module --------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.TSSLSocket - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TSSLSocketOverHttpTunnel module ----------------------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.TSSLSocketOverHttpTunnel - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TSocket module ------------------------------------------ - -.. automodule:: nebula3.fbthrift.transport.TSocket - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TSocketOverHttpTunnel module -------------------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.TSocketOverHttpTunnel - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TSocketTest module ---------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.TSocketTest - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.transport.TTransport module --------------------------------------------- - -.. automodule:: nebula3.fbthrift.transport.TTransport - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.fbthrift.transport - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.fbthrift.util.rst b/docs/source/nebula3.fbthrift.util.rst deleted file mode 100644 index 0a5e727f..00000000 --- a/docs/source/nebula3.fbthrift.util.rst +++ /dev/null @@ -1,133 +0,0 @@ -nebula3.fbthrift.util package -============================= - -Submodules ----------- - -nebula3.fbthrift.util.BytesStrIO module ---------------------------------------- - -.. automodule:: nebula3.fbthrift.util.BytesStrIO - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.Decorators module ---------------------------------------- - -.. automodule:: nebula3.fbthrift.util.Decorators - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.Recursive module --------------------------------------- - -.. automodule:: nebula3.fbthrift.util.Recursive - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.Serializer module ---------------------------------------- - -.. automodule:: nebula3.fbthrift.util.Serializer - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.TCppServerTestManager module --------------------------------------------------- - -.. automodule:: nebula3.fbthrift.util.TCppServerTestManager - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.TCppServerTestManagerTest module ------------------------------------------------------- - -.. automodule:: nebula3.fbthrift.util.TCppServerTestManagerTest - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.TValidator module ---------------------------------------- - -.. automodule:: nebula3.fbthrift.util.TValidator - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.async\_common module ------------------------------------------- - -.. automodule:: nebula3.fbthrift.util.async_common - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.asyncio module ------------------------------------- - -.. automodule:: nebula3.fbthrift.util.asyncio - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.converter module --------------------------------------- - -.. automodule:: nebula3.fbthrift.util.converter - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.fuzzer module ------------------------------------ - -.. automodule:: nebula3.fbthrift.util.fuzzer - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.inspect module ------------------------------------- - -.. automodule:: nebula3.fbthrift.util.inspect - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.randomizer module ---------------------------------------- - -.. automodule:: nebula3.fbthrift.util.randomizer - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.remote module ------------------------------------ - -.. automodule:: nebula3.fbthrift.util.remote - :members: - :undoc-members: - :show-inheritance: - -nebula3.fbthrift.util.type\_inspect module ------------------------------------------- - -.. automodule:: nebula3.fbthrift.util.type_inspect - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.fbthrift.util - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.graph.rst b/docs/source/nebula3.graph.rst deleted file mode 100644 index 15ac9a20..00000000 --- a/docs/source/nebula3.graph.rst +++ /dev/null @@ -1,37 +0,0 @@ -nebula3.graph package -===================== - -Submodules ----------- - -nebula3.graph.GraphService module ---------------------------------- - -.. automodule:: nebula3.graph.GraphService - :members: - :undoc-members: - :show-inheritance: - -nebula3.graph.constants module ------------------------------- - -.. automodule:: nebula3.graph.constants - :members: - :undoc-members: - :show-inheritance: - -nebula3.graph.ttypes module ---------------------------- - -.. automodule:: nebula3.graph.ttypes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.graph - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.mclient.rst b/docs/source/nebula3.mclient.rst deleted file mode 100644 index 08870d4f..00000000 --- a/docs/source/nebula3.mclient.rst +++ /dev/null @@ -1,10 +0,0 @@ -nebula3.mclient package -======================= - -Module contents ---------------- - -.. automodule:: nebula3.mclient - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.meta.rst b/docs/source/nebula3.meta.rst deleted file mode 100644 index 28857151..00000000 --- a/docs/source/nebula3.meta.rst +++ /dev/null @@ -1,37 +0,0 @@ -nebula3.meta package -==================== - -Submodules ----------- - -nebula3.meta.MetaService module -------------------------------- - -.. automodule:: nebula3.meta.MetaService - :members: - :undoc-members: - :show-inheritance: - -nebula3.meta.constants module ------------------------------ - -.. automodule:: nebula3.meta.constants - :members: - :undoc-members: - :show-inheritance: - -nebula3.meta.ttypes module --------------------------- - -.. automodule:: nebula3.meta.ttypes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.meta - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.rst b/docs/source/nebula3.rst index fb4c7481..bddf8c8b 100644 --- a/docs/source/nebula3.rst +++ b/docs/source/nebula3.rst @@ -7,15 +7,7 @@ Subpackages .. toctree:: :maxdepth: 4 - nebula3.common - nebula3.data - nebula3.fbthrift nebula3.gclient - nebula3.graph - nebula3.mclient - nebula3.meta - nebula3.sclient - nebula3.storage Submodules ---------- diff --git a/docs/source/nebula3.sclient.net.rst b/docs/source/nebula3.sclient.net.rst deleted file mode 100644 index 957916e1..00000000 --- a/docs/source/nebula3.sclient.net.rst +++ /dev/null @@ -1,10 +0,0 @@ -nebula3.sclient.net package -=========================== - -Module contents ---------------- - -.. automodule:: nebula3.sclient.net - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.sclient.rst b/docs/source/nebula3.sclient.rst deleted file mode 100644 index f0eecb91..00000000 --- a/docs/source/nebula3.sclient.rst +++ /dev/null @@ -1,45 +0,0 @@ -nebula3.sclient package -======================= - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - nebula3.sclient.net - -Submodules ----------- - -nebula3.sclient.BaseResult module ---------------------------------- - -.. automodule:: nebula3.sclient.BaseResult - :members: - :undoc-members: - :show-inheritance: - -nebula3.sclient.GraphStorageClient module ------------------------------------------ - -.. automodule:: nebula3.sclient.GraphStorageClient - :members: - :undoc-members: - :show-inheritance: - -nebula3.sclient.ScanResult module ---------------------------------- - -.. automodule:: nebula3.sclient.ScanResult - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.sclient - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/nebula3.storage.rst b/docs/source/nebula3.storage.rst deleted file mode 100644 index 9a9363be..00000000 --- a/docs/source/nebula3.storage.rst +++ /dev/null @@ -1,45 +0,0 @@ -nebula3.storage package -======================= - -Submodules ----------- - -nebula3.storage.GraphStorageService module ------------------------------------------- - -.. automodule:: nebula3.storage.GraphStorageService - :members: - :undoc-members: - :show-inheritance: - -nebula3.storage.StorageAdminService module ------------------------------------------- - -.. automodule:: nebula3.storage.StorageAdminService - :members: - :undoc-members: - :show-inheritance: - -nebula3.storage.constants module --------------------------------- - -.. automodule:: nebula3.storage.constants - :members: - :undoc-members: - :show-inheritance: - -nebula3.storage.ttypes module ------------------------------ - -.. automodule:: nebula3.storage.ttypes - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: nebula3.storage - :members: - :undoc-members: - :show-inheritance: