faker.sphinx.documentor

Module Contents

Functions

_get_provider_methods(provider_class)

_get_localized_provider_info(locale)

_write(fh, s)

_hide_edit_on_github(fh)

_write_title(fh, title[, level])

_write_includes(fh)

_write_standard_provider_index()

_write_base_provider_docs()

_write_standard_provider_docs()

_write_localized_provider_index()

_write_localized_provider_docs()

write_provider_docs()

Attributes

version

SECTION_ADORNMENTS

PROVIDER_AUTODOC_TEMPLATE

BASE_PROVIDER_METHOD_NAMES

faker.sphinx.documentor.version
faker.sphinx.documentor.SECTION_ADORNMENTS = '#*=-~'
faker.sphinx.documentor.PROVIDER_AUTODOC_TEMPLATE = Multiline-String
Show Value
"""
.. autoclass:: {provider_class}
   :members: {provider_methods}
   :undoc-members:
   :show-inheritance:

"""
faker.sphinx.documentor.BASE_PROVIDER_METHOD_NAMES
faker.sphinx.documentor._get_provider_methods(provider_class)
faker.sphinx.documentor._get_localized_provider_info(locale)
faker.sphinx.documentor._write(fh, s)
faker.sphinx.documentor._hide_edit_on_github(fh)
faker.sphinx.documentor._write_title(fh, title, level=1)
faker.sphinx.documentor._write_includes(fh)
faker.sphinx.documentor._write_standard_provider_index()
faker.sphinx.documentor._write_base_provider_docs()
faker.sphinx.documentor._write_standard_provider_docs()
faker.sphinx.documentor._write_localized_provider_index()
faker.sphinx.documentor._write_localized_provider_docs()
faker.sphinx.documentor.write_provider_docs()