feat: add readthedocs support (#1)

.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"

.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

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx==7.2.6
+furo==2023.9.10
+six==1.16.0
+pytz==2023.3.post1

docs/source/_autosummary/nebula3.gclient.rst

@@ -0,0 +1,23 @@
+nebula3.gclient
+===============
+
+.. automodule:: nebula3.gclient
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

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

docs/source/modules.rst

@@ -0,0 +1,7 @@
+nebula3
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   nebula3

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:

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:

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:

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:

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:

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: