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" diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..1c297521 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,19 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt 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 new file mode 100644 index 00000000..892f1743 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +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/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 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: