tfdocs.doc_controls.do_not_generate_docs

View source on GitHub

A decorator: Do not generate docs for this object.

tfdocs.doc_controls.do_not_generate_docs(
    obj: tfdocs.doc_controls.T
) -> tfdocs.doc_controls.T

For example the following classes:

class Parent(object):
  def method1(self):
    pass
  def method2(self):
    pass

class Child(Parent):
  def method1(self):
    pass
  def method2(self):
    pass

Produce the following api_docs:

/Parent.md
  # method1
  # method2
/Child.md
  # method1
  # method2

This decorator allows you to skip classes or methods:

@do_not_generate_docs
class Parent(object):
  def method1(self):
    pass
  def method2(self):
    pass

class Child(Parent):
  @do_not_generate_docs
  def method1(self):
    pass
  def method2(self):
    pass

This will only produce the following docs:

/Child.md
  # method2

class Example(object):
  @property
  @do_not_generate_docs
  def x(self):
    return self._x