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

.. py:module:: bundle.docs


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/bundle/docs/builder/index
   /autoapi/bundle/docs/cli/index
   /autoapi/bundle/docs/config/index
   /autoapi/bundle/docs/copyright/index
   /autoapi/bundle/docs/discovery/index


Classes
-------

.. autoapisummary::

   bundle.docs.DocsBuilder
   bundle.docs.DocsConfig


Package Contents
----------------

.. py:class:: DocsBuilder(config: bundle.docs.config.DocsConfig)

   Orchestrates Sphinx documentation builds.

   Creates an ephemeral staging directory with generated conf.py and index.md,
   then invokes sphinx-build via subprocess.


   .. py:attribute:: config


   .. py:method:: build() -> pathlib.Path
      :async:


      Generate Sphinx project files and run the build.

      :returns: Path to the output directory containing built HTML.



.. 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.