Skip to main content

A utility tool to help you build better sphinx documents.

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.0.tar.gz (20.2 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.0-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docfly-3.0.0.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for docfly-3.0.0.tar.gz
Algorithm Hash digest
SHA256 c0b5c4f0aba2e0cbac697fa5226b9104db7f8cac8346cc7f986544fea91bb889
MD5 3227f4941f663cc8448ea616ae3b6362
BLAKE2b-256 29877f5184281627c97993c8f9c48eb9652b3264e02adcb7520ab402f359415a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docfly-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for docfly-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cc9a9927e8e63856d81e53ae8b9722881a75cf5b21a54ed80c54f8d4af80d7e
MD5 203ef3071f944b7ba6a0d0c832281823
BLAKE2b-256 fa8321c4eca4bd2f45d43ed73dd1c2a6501979b41e94bc09cf56a63bad641846

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