Skip to main content
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

Release files for docfly 3.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docfly 3.0.3
File Size Uploaded
docfly-3.0.3.tar.gz 20.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for docfly 3.0.3
File Interpreter ABI Platform
docfly-3.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 40.3 kB

Release files / docfly-3.0.3.tar.gz

Download URL docfly-3.0.3.tar.gz
Size 20.3 kB
Tags Source
SHA-256 checksum
How to use checksums
4381b7877bd7bd5033a5f1eda2c992ed514e670c572f302797c5e37e731317c5
BLAKE2b-256 checksum
How to use checksums
601ef9765f2ce4dd5760e8f72e20a5a8c97a1d7fe0459015b7f8ab2c4c6c6953
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / docfly-3.0.3-py3-none-any.whl

Download URL docfly-3.0.3-py3-none-any.whl
Size 20.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b5462addeac7a8626f18d52a1cb10b3944765a948834c6440e3f5f011d6b649
BLAKE2b-256 checksum
How to use checksums
8bb0c3832d3af9512ed71eabfd23d878066e7376d7415d8c8fb9030fc291a2bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

3.0.3 This release

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

1.1.1

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.4

1 release file

0.0.3

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page