.. pypi-sphinx-quickstart documentation master file, created by
   pypi-sphinx-quickstart.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Repo Splitter documentation!
*********************************************

This is a GUI, Python, and CLI tool for splitting repos. If you have a part of a repo which
you would now like to be a separate repo, and you would like to separate the history
of the two repos such that the new repo contains commits referencing its files and
any references to those files in the old repo have been removed, then this is
the tool for you.

To get started, look here.

.. toctree::

   tutorial


An overview
===========

These are the Python commands. For examples and CLI usage, see :ref:`tutorial`.

.. autosummary::

      repo_splitter.__main__.split_repo
      repo_splitter.__main__.remove_from_repo_history
      repo_splitter.__main__.restore_from_backup


API Documentation
------------------

A full list of modules

.. toctree:: api/modules
   :maxdepth: 3

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`