Release v3.0.3 (What’s new?).

Documentation Status https://github.com/MacHu-GWU/docfly-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/docfly-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/docfly.svg https://img.shields.io/pypi/l/docfly.svg https://img.shields.io/pypi/pyversions/docfly.svg https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to docfly Documentation

https://docfly.readthedocs.io/en/latest/_static/docfly-logo.png

docfly is a utility tool that simplifies Sphinx documentation 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

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

$ pip install docfly

To upgrade to latest version:

$ pip install --upgrade docfly

Table of Content

About the Author

(\ (\
( -.-)o
o_(")(")

Sanhe Hu is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of 150+ open-source Python projects, with over 15 million monthly downloads, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in AI, Data, Amazon Web Services, Cloud Engineering, DevOps, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.

Talk is cheap, show me the code:

API Document