mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
fix: regenerate protobuf files to match runtime version
This commit is contained in:
committed by
Paul Robinson
parent
1730999e38
commit
86dce72ae0
31
docs/conf.py
31
docs/conf.py
@ -13,9 +13,10 @@
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
DIR = os.path.dirname(__file__)
|
||||
with open(os.path.join(DIR, "../setup.py"), "r") as f:
|
||||
@ -36,7 +37,13 @@ extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.doctest",
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx_rtd_theme",
|
||||
"sphinx.ext.todo",
|
||||
"sphinx.ext.coverage",
|
||||
"sphinx.ext.mathjax",
|
||||
"sphinx.ext.ifconfig",
|
||||
"sphinx.ext.viewcode",
|
||||
"sphinx.ext.githubpages",
|
||||
"sphinx.ext.napoleon",
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
@ -53,7 +60,8 @@ master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = "py-libp2p"
|
||||
copyright = '2019, The Ethereum Foundation'
|
||||
copyright = "2019, The libp2p team"
|
||||
author = "The libp2p team"
|
||||
|
||||
__version__ = setup_version
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
@ -316,7 +324,6 @@ doctest_default_flags = (
|
||||
# Mock out dependencies that are unbuildable on readthedocs, as recommended here:
|
||||
# https://docs.readthedocs.io/en/rel/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
|
||||
|
||||
import sys
|
||||
from unittest.mock import MagicMock
|
||||
|
||||
# Add new modules to mock here (it should be the same list as those excluded in setup.py)
|
||||
@ -326,3 +333,17 @@ MOCK_MODULES = [
|
||||
"fastecdsa.encoding.sec1",
|
||||
]
|
||||
sys.modules.update((mod_name, MagicMock()) for mod_name in MOCK_MODULES)
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
||||
# -- Options for todo extension ----------------------------------------------
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
|
||||
# -- Options for autodoc extension ------------------------------------------
|
||||
|
||||
# Allow duplicate object descriptions
|
||||
nitpicky = False
|
||||
nitpick_ignore = [("py:class", "type")]
|
||||
suppress_warnings = ["app.add_directive"]
|
||||
|
||||
37
docs/libp2p.host.autonat.pb.rst
Normal file
37
docs/libp2p.host.autonat.pb.rst
Normal file
@ -0,0 +1,37 @@
|
||||
libp2p.host.autonat.pb package
|
||||
==============================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
libp2p.host.autonat.pb.autonat\_pb2 module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat.pb.autonat_pb2
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
libp2p.host.autonat.pb.autonat\_pb2\_grpc module
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat.pb.autonat_pb2_grpc
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
libp2p.host.autonat.pb.generate\_proto module
|
||||
---------------------------------------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat.pb.generate_proto
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat.pb
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
29
docs/libp2p.host.autonat.rst
Normal file
29
docs/libp2p.host.autonat.rst
Normal file
@ -0,0 +1,29 @@
|
||||
libp2p.host.autonat package
|
||||
===========================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
libp2p.host.autonat.pb
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
libp2p.host.autonat.autonat module
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat.autonat
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat
|
||||
:members:
|
||||
:show-inheritance:
|
||||
:undoc-members:
|
||||
@ -4,6 +4,14 @@ libp2p.host package
|
||||
Submodules
|
||||
----------
|
||||
|
||||
libp2p.host.autonat module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: libp2p.host.autonat
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
libp2p.host.basic\_host module
|
||||
------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user