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

.. py:module:: bundle.docs.cli

.. autoapi-nested-parse::

   bundle docs CLI

     bundle docs build      [--source .] [--output docs/_build/html] [--package src/bundle] [--theme furo]
     bundle docs serve      [--output docs/_build/html] [--port 8000]
     bundle docs init       [--source .]
     bundle docs copyright  update --year 2026 [--source .]
     bundle docs copyright  check  [--source .]
     bundle docs copyright  add    --year 2026 --owner Name [--source .]



Attributes
----------

.. autoapisummary::

   bundle.docs.cli.log


Functions
---------

.. autoapisummary::

   bundle.docs.cli.docs
   bundle.docs.cli.build
   bundle.docs.cli.serve
   bundle.docs.cli.init
   bundle.docs.cli.copyright
   bundle.docs.cli.check
   bundle.docs.cli.update
   bundle.docs.cli.add


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

.. py:data:: log

.. py:function:: docs()
   :async:


   Build and serve Sphinx documentation.


.. py:function:: build(source: str, output: str, package: str | None, theme: str)
   :async:


   Build HTML documentation from docstrings and READMEs.


.. py:function:: serve(output: str, port: int)
   :async:


   Serve built documentation locally for preview.


.. py:function:: init(source: str)
   :async:


   Initialize persistent Sphinx configuration files in a project.


.. py:function:: copyright()
   :async:


   Manage copyright headers in source files.


.. py:function:: check(source: str)
   :async:


   Report which files have or lack a copyright header.


.. py:function:: update(source: str, year: int)
   :async:


   Update the copyright year in all files that already have a header.


.. py:function:: add(source: str, year: int, owner: str)
   :async:


   Add a copyright + license header to files that lack one.