Metadata-Version: 2.4
Name: docfly
Version: 3.0.2
Summary: A utility tool to help you build better sphinx documents.
Author-email: Sanhe Hu <husanhe@gmail.com>
Maintainer-email: Sanhe Hu <husanhe@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/MacHu-GWU/docfly-project
Project-URL: Documentation, https://docfly.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/MacHu-GWU/docfly-project
Project-URL: Issues, https://github.com/MacHu-GWU/docfly-project/issues
Project-URL: Changelog, https://github.com/MacHu-GWU/docfly-project/blob/main/release-history.rst
Project-URL: Download, https://pypi.org/pypi/docfly#files
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Requires-Python: <4.0,>=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: jinja2
Requires-Dist: Sphinx
Requires-Dist: picage<2.0.0,>=1.0.0
Provides-Extra: dev
Requires-Dist: rich<14.0.0,>=13.8.1; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest<9.0.0,>=8.2.2; extra == "test"
Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "test"
Provides-Extra: doc
Requires-Dist: Sphinx<8.0.0,>=7.4.7; extra == "doc"
Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
Requires-Dist: sphinx-design<1.0.0,>=0.6.1; extra == "doc"
Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
Requires-Dist: furo==2024.8.6; extra == "doc"
Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
Requires-Dist: nbsphinx<1.0.0,>=0.8.12; extra == "doc"
Requires-Dist: rstobj==1.2.1; extra == "doc"
Provides-Extra: mise
Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
Requires-Dist: httpx<1.0.0,>=0.28.0; extra == "mise"
Requires-Dist: tomli<3.0.0,>=2.0.0; python_version < "3.11" and extra == "mise"
Dynamic: license-file


.. image:: https://readthedocs.org/projects/docfly/badge/?version=latest
    :target: https://docfly.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/docfly-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/docfly-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/docfly-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/docfly-project

.. image:: https://img.shields.io/pypi/v/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/pypi/l/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/pypi/pyversions/docfly.svg
    :target: https://pypi.python.org/pypi/docfly

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/docfly-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/docfly-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://docfly.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/docfly-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/docfly#files


Welcome to ``docfly`` Documentation
==============================================================================
.. image:: https://docfly.readthedocs.io/en/latest/_static/docfly-logo.png
    :target: https://docfly.readthedocs.io/en/latest/

``docfly`` is a utility tool that simplifies `Sphinx documentation <http://www.sphinx-doc.org/en/stable/index.html>`_ creation by automating repetitive tasks.

**Key Features**

- **Automatic API Reference Generation**: Creates comprehensive .rst files for your entire package structure
- **Automatic Table of Contents**: Generates and maintains toctree directives that stay in sync with your folder structure
- **Multi-Language Support**: Simplifies creating documentation in multiple languages
- **Jupyter Notebook Integration**: Seamlessly incorporates Jupyter notebooks into your documentation


.. _install:

Install
------------------------------------------------------------------------------

``docfly`` is released on PyPI, so all you need is:

.. code-block:: console

    $ pip install docfly

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade docfly
