generate_docs Namespace Reference

Functions
def	find_modules ()
def	main ()
def	replace_toc (modules)
def	write_automodule (module)

Variables
string	AUTOMODULE_TEMPLATE
	DOCS_DIR = pathlib.Path(__file__).parent.resolve()
tuple	IGNORED_MODULES
tuple	IGNORED_PACKAGES
tuple	INCLUDED_MODULES
	PYTHON_DIR = DOCS_DIR.parent
string	SOURCE_DIR = PYTHON_DIR / "google" / "protobuf"
string	SOURCE_POSIX = SOURCE_DIR.as_posix()
	TOC_REGEX
string	TOC_TEMPLATE

Function Documentation

find_modules()

def generate_docs.find_modules

(

)

Definition at line 131 of file generate_docs.py.

main()

def generate_docs.main

(

)

Definition at line 183 of file generate_docs.py.

replace_toc()

def generate_docs.replace_toc

(

modules

)

Definition at line 171 of file generate_docs.py.

write_automodule()

def generate_docs.write_automodule

(

module

)

Definition at line 160 of file generate_docs.py.

Variable Documentation

AUTOMODULE_TEMPLATE

string generate_docs.AUTOMODULE_TEMPLATE

Initial value:

=  """.. DO NOT EDIT, generated by generate_docs.py.
 
.. ifconfig:: build_env == 'readthedocs'
 
   .. warning::
 
      You are reading the documentation for the `latest committed changes
      <https://github.com/protocolbuffers/protobuf/tree/master/python>`_ of
      the `Protocol Buffers package for Python
      <https://developers.google.com/protocol-buffers/docs/pythontutorial>`_.
      Some features may not yet be released. Read the documentation for the
      latest released package at `googleapis.dev
      <https://googleapis.dev/python/protobuf/latest/>`_.
 
{module}
{underline}
 
.. automodule:: {module}
   :members:
   :inherited-members:
   :undoc-members:
"""

Definition at line 107 of file generate_docs.py.

DOCS_DIR

generate_docs.DOCS_DIR = pathlib.Path(__file__).parent.resolve()

Definition at line 66 of file generate_docs.py.

IGNORED_MODULES

tuple generate_docs.IGNORED_MODULES

Initial value:

=  (
  "any_test_pb2",
  "api_pb2",
  "unittest",
  "source_context_pb2",
  "test_messages_proto3_pb2",
  "test_messages_proto2",
)

Definition at line 86 of file generate_docs.py.

IGNORED_PACKAGES

tuple generate_docs.IGNORED_PACKAGES

Initial value:

=  (
  "compiler",
  "docs",
  "internal",
  "pyext",
  "util",
)

Definition at line 77 of file generate_docs.py.

INCLUDED_MODULES

tuple generate_docs.INCLUDED_MODULES

Initial value:

=  (
  "google.protobuf.internal.containers",
)

Definition at line 72 of file generate_docs.py.

PYTHON_DIR

generate_docs.PYTHON_DIR = DOCS_DIR.parent

Definition at line 67 of file generate_docs.py.

SOURCE_DIR

string generate_docs.SOURCE_DIR = PYTHON_DIR / "google" / "protobuf"

Definition at line 68 of file generate_docs.py.

SOURCE_POSIX

string generate_docs.SOURCE_POSIX = SOURCE_DIR.as_posix()

Definition at line 69 of file generate_docs.py.

TOC_REGEX

generate_docs.TOC_REGEX

Initial value:

=  re.compile(
  r"\.\. START REFTOC.*\.\. END REFTOC\.\n",
  flags=re.DOTALL,
)

Definition at line 95 of file generate_docs.py.

TOC_TEMPLATE

string generate_docs.TOC_TEMPLATE

Initial value:

=  """.. START REFTOC, generated by generate_docs.py.
.. toctree::
 
   {toctree}
 
.. END REFTOC.
"""

Definition at line 99 of file generate_docs.py.