Skip to main content

A utility tool to help you build better sphinx documents.

Reason this release was yanked:

forget to publish template

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docfly-3.0.1.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docfly-3.0.1-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file docfly-3.0.1.tar.gz.

File metadata

  • Download URL: docfly-3.0.1.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for docfly-3.0.1.tar.gz
Algorithm Hash digest
SHA256 50a56e845195ab29645930bc48c0805a1a9bc7a46459775d2da261f90fff6c3e
MD5 b37ac94d98a865d15e8989032d5b5dbb
BLAKE2b-256 5d1bea52e1c7722a481999c2a9d07c2768f63d2e0718034f14af09bc1ae6a7e8

See more details on using hashes here.

File details

Details for the file docfly-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: docfly-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 19.1 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for docfly-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 84bc113ddb47a67747277bc9de63cd75bfcc98f233931de8e6857aad80cc2b6e
MD5 21e03ec1226d8d6e4f4528a85998c876
BLAKE2b-256 11ddc17fc05217826c37c759d6ab56e5f01ad5f6bb2a495c550d76db4fac2b95

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page