doks


Namedoks JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/rec/doks
SummaryAutomatically generated READMEs
upload_time2021-01-12 11:14:35
maintainer
docs_urlNone
authorTom Ritchford
requires_python
licenseMIT
keywords documentation
VCS
bugtrack_url
requirements impall pyyaml readme-renderer safer toml
Travis-CI
coveralls test coverage
            doks
----

Usage
=====

.. code-block:: bash

       doks [-h] [--auto] [--command] [--force] [--verbose] [--window WINDOW]
            [source] [target]

Description
===========

Write a .rst document for a single Python file

Positional arguments
====================

``source``
  .py file to create documentation for

``target``
  .rst file to write to. None means stdout

Optional arguments
==================

``-h``, ``--help``
  Show this help message and exit

``--auto``, ``-a``
  Automatically guess which files to read and write

``--command``, ``-c``
  Use command line help from executing source instead

``--force``, ``-f``
  Write .rst documentation even if it is malformed

``--verbose``, ``-v``
  Print more stuff

``--window WINDOW``, ``-w WINDOW``
  How many lines around an RST error to print (0 means "print
  everything")

(automatically generated by `doks <https://github.com/rec/doks/>`_ on 2021-01-10T17:42:40.617077)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rec/doks",
    "name": "doks",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "documentation",
    "author": "Tom Ritchford",
    "author_email": "tom@swirly.com",
    "download_url": "https://files.pythonhosted.org/packages/25/6d/a3e85f8a1e96f5427aa6c3825cf49a0bae40f14bf943599e24bcce51b7e1/doks-1.0.1.tar.gz",
    "platform": "",
    "description": "doks\n----\n\nUsage\n=====\n\n.. code-block:: bash\n\n       doks [-h] [--auto] [--command] [--force] [--verbose] [--window WINDOW]\n            [source] [target]\n\nDescription\n===========\n\nWrite a .rst document for a single Python file\n\nPositional arguments\n====================\n\n``source``\n  .py file to create documentation for\n\n``target``\n  .rst file to write to. None means stdout\n\nOptional arguments\n==================\n\n``-h``, ``--help``\n  Show this help message and exit\n\n``--auto``, ``-a``\n  Automatically guess which files to read and write\n\n``--command``, ``-c``\n  Use command line help from executing source instead\n\n``--force``, ``-f``\n  Write .rst documentation even if it is malformed\n\n``--verbose``, ``-v``\n  Print more stuff\n\n``--window WINDOW``, ``-w WINDOW``\n  How many lines around an RST error to print (0 means \"print\n  everything\")\n\n(automatically generated by `doks <https://github.com/rec/doks/>`_ on 2021-01-10T17:42:40.617077)\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Automatically generated READMEs",
    "version": "1.0.1",
    "split_keywords": [
        "documentation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ea01f1af5d561224776e8294128e3cc7",
                "sha256": "950f002b6cefe46ed08bc25cac5e1bd58585aa4533d603a98c3e2c1604056a18"
            },
            "downloads": -1,
            "filename": "doks-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ea01f1af5d561224776e8294128e3cc7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18841,
            "upload_time": "2021-01-12T11:14:34",
            "upload_time_iso_8601": "2021-01-12T11:14:34.074319Z",
            "url": "https://files.pythonhosted.org/packages/b6/c6/b947f825dd2838d01d6fa1f48b85630165cf4bfe1370c9e3c48b9c707e4c/doks-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b5fca2f870adba1abfa3ad7c0713afe1",
                "sha256": "2ea8f658d273d9d57f9a0239a10a39905b8ba2e3eb925a8f2eb70932b5aa4488"
            },
            "downloads": -1,
            "filename": "doks-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b5fca2f870adba1abfa3ad7c0713afe1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 21363,
            "upload_time": "2021-01-12T11:14:35",
            "upload_time_iso_8601": "2021-01-12T11:14:35.595475Z",
            "url": "https://files.pythonhosted.org/packages/25/6d/a3e85f8a1e96f5427aa6c3825cf49a0bae40f14bf943599e24bcce51b7e1/doks-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-01-12 11:14:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "rec",
    "github_project": "doks",
    "travis_ci": true,
    "coveralls": true,
    "github_actions": false,
    "requirements": [
        {
            "name": "impall",
            "specs": []
        },
        {
            "name": "pyyaml",
            "specs": []
        },
        {
            "name": "readme-renderer",
            "specs": []
        },
        {
            "name": "safer",
            "specs": []
        },
        {
            "name": "toml",
            "specs": []
        }
    ],
    "test_requirements": [
        {
            "name": "beautifulsoup4",
            "specs": []
        },
        {
            "name": "coverage",
            "specs": []
        },
        {
            "name": "flake8",
            "specs": []
        },
        {
            "name": "impall",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "readme-renderer",
            "specs": []
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "tdir",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "doks"
}
        
Elapsed time: 0.02126s