bundle.docs.config
==================

.. py:module:: bundle.docs.config


Attributes
----------

.. autoapisummary::

   bundle.docs.config.log


Classes
-------

.. autoapisummary::

   bundle.docs.config.DocsConfig


Module Contents
---------------

.. py:data:: log

.. py:class:: DocsConfig(/, **data: Any)

   Bases: :py:obj:`bundle.core.data.Data`


   Configuration for a Sphinx documentation build.


   .. py:attribute:: project_name
      :type:  str
      :value: 'TheBundle'



   .. py:attribute:: project_version
      :type:  str
      :value: ''



   .. py:attribute:: author
      :type:  str
      :value: ''



   .. py:attribute:: source_dir
      :type:  pathlib.Path
      :value: None



   .. py:attribute:: output_dir
      :type:  pathlib.Path
      :value: None



   .. py:attribute:: package_dirs
      :type:  list[str]
      :value: None



   .. py:attribute:: autoapi_dirs
      :type:  list[str]
      :value: None



   .. py:attribute:: theme
      :type:  str
      :value: 'furo'



   .. py:attribute:: include_readmes
      :type:  bool
      :value: True



   .. py:attribute:: extensions
      :type:  list[str]
      :value: None



   .. py:method:: generate_conf_py() -> str

      Render a complete Sphinx conf.py as a string.