.. image:: https://github.com/MacHu-GWU/docfly-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/docfly-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/docfly-project/branch/master/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/docfly-project
.. image:: https://readthedocs.org/projects/docfly/badge/?version=latest
:target: https://docfly.readthedocs.io/?badge=latest
:alt: Documentation Status
.. 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/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/docfly-project
------
.. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://docfly.readthedocs.io/index.html
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://docfly.readthedocs.io/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: https://docfly.readthedocs.io/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
==============================================================================
.. contents::
:class: this-will-duplicate-information-and-it-is-still-useful-here
:depth: 1
:local:
``docfly`` is a utility tools to minimize your work using `sphinx-doc <http://www.sphinx-doc.org/en/stable/index.html>`_
Full document can be cond `HERE <https://docfly.readthedocs.io/>`_
**Feature**:
- Automatic API Reference Doc Generation.
- Easy Table of Content directive Generation (``.. toctree::``).
.. _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
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/docfly-project",
"name": "docfly",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@me.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@me.com",
"download_url": "https://files.pythonhosted.org/packages/21/28/666b53b83dbe4cbb6d94050d1e8192a096e32a20a082bfdeef9b0319db96/docfly-2.0.3.tar.gz",
"platform": "Windows",
"description": ".. image:: https://github.com/MacHu-GWU/docfly-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/docfly-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/docfly-project/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/docfly-project\n\n.. image:: https://readthedocs.org/projects/docfly/badge/?version=latest\n :target: https://docfly.readthedocs.io/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/docfly.svg\n :target: https://pypi.python.org/pypi/docfly\n\n.. image:: https://img.shields.io/pypi/l/docfly.svg\n :target: https://pypi.python.org/pypi/docfly\n\n.. image:: https://img.shields.io/pypi/pyversions/docfly.svg\n :target: https://pypi.python.org/pypi/docfly\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/docfly-project\n\n------\n\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://docfly.readthedocs.io/index.html\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://docfly.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://docfly.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/docfly-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/docfly-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/docfly-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/docfly#files\n\n\nWelcome to ``docfly`` Documentation\n==============================================================================\n\n.. contents::\n :class: this-will-duplicate-information-and-it-is-still-useful-here\n :depth: 1\n :local:\n\n\n``docfly`` is a utility tools to minimize your work using `sphinx-doc <http://www.sphinx-doc.org/en/stable/index.html>`_\n\nFull document can be cond `HERE <https://docfly.readthedocs.io/>`_\n\n**Feature**:\n\n- Automatic API Reference Doc Generation.\n- Easy Table of Content directive Generation (``.. toctree::``).\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``docfly`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install docfly\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade docfly\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A utility tool to help you build better sphinx documents.",
"version": "2.0.3",
"project_urls": {
"Download": "https://pypi.python.org/pypi/docfly/2.0.3#downloads",
"Homepage": "https://github.com/MacHu-GWU/docfly-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b0502293ef67ba35f84a3b7d2421ec8bcfa03efd1e5c10567026900bde6332c",
"md5": "25c4ed45a1214b36c596e5a03b7068bc",
"sha256": "85b72bcb7725fcd9eb250f3836748a2686cc1137ac8a1dfb2ee6b828cda1e634"
},
"downloads": -1,
"filename": "docfly-2.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "25c4ed45a1214b36c596e5a03b7068bc",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 40319,
"upload_time": "2024-02-02T17:50:22",
"upload_time_iso_8601": "2024-02-02T17:50:22.473311Z",
"url": "https://files.pythonhosted.org/packages/1b/05/02293ef67ba35f84a3b7d2421ec8bcfa03efd1e5c10567026900bde6332c/docfly-2.0.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2128666b53b83dbe4cbb6d94050d1e8192a096e32a20a082bfdeef9b0319db96",
"md5": "d7f4b83bc456d0ac085989d623307763",
"sha256": "aba7774894e1dff8a2dcc2f28ab649cc314bcd1324204b2a37394488ae3fa158"
},
"downloads": -1,
"filename": "docfly-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d7f4b83bc456d0ac085989d623307763",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34621,
"upload_time": "2024-02-02T17:50:24",
"upload_time_iso_8601": "2024-02-02T17:50:24.364755Z",
"url": "https://files.pythonhosted.org/packages/21/28/666b53b83dbe4cbb6d94050d1e8192a096e32a20a082bfdeef9b0319db96/docfly-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-02 17:50:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "docfly-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "docfly"
}