{
    "info": {
        "author": "Oliver Steele",
        "author_email": "steele@osteele.com",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Console",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3.6",
            "Topic :: Documentation",
            "Topic :: Documentation :: Sphinx",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "Flinx\n=====\n\nConfiguration-free Sphinx package documentation.\n\nFlinx aims to be for documentation what Flit is for packaging: a\nconfiguration-free way to get started on {documentation, packaging}, and add\nconfiguration gradually. It also borrows a concept from react-starter-kit: you\ncan \u201ceject\u201d, and leave Flinx behind.\n\nThis tool isn't for everyone. Flinx is a thin wrapper around ``sphinx-build``\nand ``sphinx-autobuild``. If you're happy creating a ``docs/conf.py`` and using\nthose commands directly, you don't need this one.\n\nSigns you might be interested in this package:\n\n* You want zero-configuration documentation for new projects.\n* You don't want to edit both your module source and ``conf.py``, when\n  you rename your module. (I know, you shouldn't do this after you've published.\n  But I do this a lot during initial development.)\n* You don't want to manually edit both your module source, and ``conf.py``,\n  when you bump the version number. (Although `bumpversion\n  <https://github.com/peritus/bumpversion>`_ is an alternative, here.)\n* You're an eager guinea pig for early-stage software.\n\nInstallation\n------------\n\n::\n\n    $ python3 -m pip install flinx\n\nUsage\n-----\n\n::\n\n  $ flinx build\n\nUses `sphinx-build` to build the HTML documentation.\n\n``flinx build -o`` opens a browser onto the documentation once it's been built.\n\n.. todo:: Currently this pollutes ``./docs``.\n\n::\n\n  $ flinx serve\n\nUses ``sphinx-autobuild`` to build and serve the HTML documentation.\n\n``flinx serve -o`` opens a browser onto the documentation once it's been built.\n\nThanks to ``sphinx-autobuild``, the documentation will re-build and re-run when\nthe sources are changed.\n\nThis doesn't extend to the ``pyproject.toml`` configuration file.\n\n::\n\n  $ flinx generate\n\nWrites ``docs/conf.py`` and ``docs/index.rst``, that match the current project\nsettings.\n\n::\n\n  $ flinx eject\n\nThis is equivalent to ``flinx generate``, except that the files omit the \"THIS\nFILE IS AUTOMATICALLY GENERATED\" warning in the header.\n\n.. note::\n   These command-line options are pretty different from ``sphinx-build`` and\n   ``sphinx-autobuild``. This falls under the heading of \u201cif you're happy with\n   those tools and know your way around their options, you probably won't like\n   this package\u201d. They're designed to be more like *other* site generators that\n   I use, such as Jekyll. Since I *don't* know my way around ``sphinx-build``,\n   I'm not trying to be compatible with it.\n\nConfiguration\n-------------\n\nIf pyproject.toml_ exists and contains a ``[tool.flinx.metadata]`` table, the\nproject name, author, version, copyright date (``date``), and description file\nare read from that. These are all optional.\n\nIf ``pyproject.toml`` contains a ``[tool.flit.metadata]`` Flit_\nconfiguration table, the project name, author, and description file are read\nfrom that.\n\nIf ``pyproject.toml`` contains a ``[tool.poetry]`` Poetry_ configuration table,\nthe project name, author, and version are read from that.\n\nFlinx attempts to automatically discover any information that isn't specified in\nthe project file:\n\n* Flinx attempts to detect the module. This is the first non-test\n  directory that contains an ``__init__.py`` file that contains a version\n  definition, else it's the first non-test ``*.py`` file that contains a version\n  definition. A version definition is a line of the format ``__version__ =\n  \"1.2.3\"``, with single or double quotes. (Flinx ignores whitespace, but does\n  not import or parse the file.)\n* Flix reads the version from the module file (if the module is a single file), or from the\n  module's `__init__.py` file (if the module is a directory).\n* The author is read from `git config user.name`. It's an error if there's\n  no project file, and the author isn't available via git.\n* The copyright date is the current year.\n\nAdd `Sphinx configuration`_ variables to a ``[tool.flinx.configuration]`` table\nin ``pyproject.toml``. For example:\n\n::\n\n  [tool.flinx.configuration]\n  html_theme = 'sphinx_rtd_theme'\n\nExtensions in the ``sphinx.ext`` namespace can be abbreviated. For example,\n``extensions = ['napoleon', 'todo']`` is equivalent to ``extensions =\n['sphinx.ext.napoleon', 'sphinx.ext.todo']``.\n\nExtensions from ``sphinx.ext`` are automatically added, if there's a\nconfiguration variable that begins with the name of that estension. For example,\nthe presence of ``todo_include_todos = true`` in the project file implies\n``sphinx.ext.todo``.\n\n.. _pyproject.toml: https://www.python.org/dev/peps/pep-0518/\n.. _Flit: https://flit.readthedocs.io/en/latest/\n.. _Poetry: https://poetry.eustace.io\n.. _Sphinx configuration: http://www.sphinx-doc.org/en/master/usage/configuration.html\n\nLimitations\n-----------\n\nFlinx isn't compatible with Read the Docs. This is planned, but tricky.\n\nAcknowledgements\n-----------------\n\nInspired by `flit <https://flit.readthedocs.io/en/latest/>`_. Built on `sphinx\n<http://www.sphinx-doc.org/en/master/>`_ and `sphinx-autobuild\n<https://github.com/GaretJax/sphinx-autobuild>`_.\n\nAbout the Name\n--------------\n\n\u201cFlinx\u201d is a mash-up of \u201cflit\u201d and \u201csphinx\u201d. I wanted to name it \u201cflynx\u201d, as a\ntribute to `Seveneves <https://en.wikipedia.org/wiki/Seveneves>`_, but I\nrealized I'd been spelling \u201csphinx\u201d wrong. There's an app named \u201cFlynx\u201d, so it's\nprobably just as well.\n\n\u201cFlinx\u201d is also a character in an Allen Dean Foster series. I regret to admit\nthat I haven't read that series, and that it didn't inform my choice of names.\n\nLicense\n-------\n\nMIT\n",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/osteele/flinx",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "flinx",
        "package_url": "https://pypi.org/project/flinx/",
        "platform": "",
        "project_url": "https://pypi.org/project/flinx/",
        "project_urls": {
            "Documentation": "https://flinx.readthedocs.io/en/latest/",
            "Homepage": "https://github.com/osteele/flinx"
        },
        "release_url": "https://pypi.org/project/flinx/0.2.0/",
        "requires_dist": [
            "click",
            "flit",
            "Sphinx",
            "sphinx-autobuild"
        ],
        "requires_python": ">=3.5",
        "summary": "Configuration-free Python doc generation via Sphinx.",
        "version": "0.2.0"
    },
    "last_serial": 3971773,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "591d142006d62783b0ff7ac36995d9c8",
                    "sha256": "ead6c72ded780568e834465ca9624d6c45e7b600911b45ef2f249645231af912"
                },
                "downloads": -1,
                "filename": "flinx-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "591d142006d62783b0ff7ac36995d9c8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 7462,
                "upload_time": "2018-06-11T23:33:14",
                "url": "https://files.pythonhosted.org/packages/bc/d7/2ea6a159028b93e15b65477f6729514bc63fff2b800bc67e164e58a1505d/flinx-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "51e774c1aefaf2f65f2022ac6265c08d",
                    "sha256": "3c24f34f22a4bf5d1f99ea6e64087bb61f9d141bcecb7b0bf0733e1523df14b1"
                },
                "downloads": -1,
                "filename": "flinx-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "51e774c1aefaf2f65f2022ac6265c08d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 9910,
                "upload_time": "2018-06-11T23:33:17",
                "url": "https://files.pythonhosted.org/packages/91/e3/b857a6b7d778a67384329688e7ec523f122b851453d8a429cfd99494cbaa/flinx-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "efa1ebab6f44148e04fd3c6db118b615",
                    "sha256": "09e35bfdcce3d6f66fb39c9b3242cf7cd939f6ff6f9b14ad101307fe4e1021b5"
                },
                "downloads": -1,
                "filename": "flinx-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "efa1ebab6f44148e04fd3c6db118b615",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 7544,
                "upload_time": "2018-06-12T02:11:40",
                "url": "https://files.pythonhosted.org/packages/ac/06/8011ed84157c8f921b27dd0700fbcbdc2e20ba90c5eb172ff46e424069ee/flinx-0.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d52468f15072aeae52e9f98fdda733ab",
                    "sha256": "da6a53c18a1c892834fb2cfd888f174edd8fb0197b5c660db97c9426e58435e8"
                },
                "downloads": -1,
                "filename": "flinx-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d52468f15072aeae52e9f98fdda733ab",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 10701,
                "upload_time": "2018-06-12T02:11:42",
                "url": "https://files.pythonhosted.org/packages/de/f0/9ab06cd6ff757910dda08fcd464db0cb80364d8acd494eb8792b8b162c64/flinx-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "54026d2596a11947ee2bc630b73cfa59",
                    "sha256": "b8a58c6978072492d0c20d9cee77d55672413ceffd6e2b0376d64da372ee5675"
                },
                "downloads": -1,
                "filename": "flinx-0.1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "54026d2596a11947ee2bc630b73cfa59",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 19579,
                "upload_time": "2018-06-12T23:35:42",
                "url": "https://files.pythonhosted.org/packages/ac/03/38f8dcab7b3992ea69f3ae388d0b9f5b678935000202182c1e9742eab2e1/flinx-0.1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "29b63cb1d18ae2500a7df26394aab48f",
                    "sha256": "273bad840a4b1a489d6003195d28fe75bef2f91c8db382f8619c6063a4b77587"
                },
                "downloads": -1,
                "filename": "flinx-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "29b63cb1d18ae2500a7df26394aab48f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 13428,
                "upload_time": "2018-06-12T23:35:44",
                "url": "https://files.pythonhosted.org/packages/eb/9b/9b5e19acd80cc82ec9aeb92e00d27d4c775ea7e03e13d3d959028b2defea/flinx-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6ebadbfb464a8c9bdb9bb0c993295e18",
                    "sha256": "c3a9ab490cc3521564115a088fd2c67354bd59dbb0df4732adfa0a61a5e75663"
                },
                "downloads": -1,
                "filename": "flinx-0.1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6ebadbfb464a8c9bdb9bb0c993295e18",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 20185,
                "upload_time": "2018-06-14T20:07:07",
                "url": "https://files.pythonhosted.org/packages/c7/95/9976a96c25461705873106eb69a5d8f2a3d68243b6100f012e0390ad1b7f/flinx-0.1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "686457a4fe92e1ffcbfecf7605ab16dc",
                    "sha256": "040d52c8ca9a3fd343f511223124b08ef162c4888ec6277dc33b031836f3d0f9"
                },
                "downloads": -1,
                "filename": "flinx-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "686457a4fe92e1ffcbfecf7605ab16dc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 15777,
                "upload_time": "2018-06-14T20:07:09",
                "url": "https://files.pythonhosted.org/packages/db/a7/6487b98a4bd565b33102a86c0ec858ab43f30e32a826ad1ccdabd95d2a00/flinx-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "27d63ffafcfead28627342e9b4f9062b",
                    "sha256": "b9653f2630a1a7b11e330dc36c89066ed3be2cd7bd0274da928e7a068ca08b62"
                },
                "downloads": -1,
                "filename": "flinx-0.1.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "27d63ffafcfead28627342e9b4f9062b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 21738,
                "upload_time": "2018-06-15T18:54:20",
                "url": "https://files.pythonhosted.org/packages/cf/e0/01940bdf32e37df5a2be00da7709a7cc9a4c819207d9d595065dc0068b30/flinx-0.1.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b94ea97c4a5eb01d65b2b75c1b10b9e1",
                    "sha256": "c59fc834d744638f2fd955f878dfe6fc56d03b87c53097e54bc16336226bea23"
                },
                "downloads": -1,
                "filename": "flinx-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "b94ea97c4a5eb01d65b2b75c1b10b9e1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 16247,
                "upload_time": "2018-06-15T18:54:22",
                "url": "https://files.pythonhosted.org/packages/a4/88/89287d4a2ef286e57952ccab26ac41572026e26af1258746b61f74b5d977/flinx-0.1.4.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f685e213d1d7ad391689d5aa31cc50e0",
                    "sha256": "e93251cd396c0e1dab6e2f8a70b2d2a19aae7366b415c8d2f786eeb4a09936fe"
                },
                "downloads": -1,
                "filename": "flinx-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "f685e213d1d7ad391689d5aa31cc50e0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.5",
                "size": 24619,
                "upload_time": "2018-06-17T19:45:50",
                "url": "https://files.pythonhosted.org/packages/28/4a/abd9a0d5315ee41411a2fa5c58fc7a71bf2d8a1b4ef0b6126df43430f9c9/flinx-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "65f873a230ee28e895009ee8ea417157",
                    "sha256": "8966528c70b72ae2ea31bccc2c1e3fb2861ee26358ea8db3ded213f2792571ff"
                },
                "downloads": -1,
                "filename": "flinx-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "65f873a230ee28e895009ee8ea417157",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.5",
                "size": 18432,
                "upload_time": "2018-06-17T19:45:52",
                "url": "https://files.pythonhosted.org/packages/d4/ed/6c4010c53dcb348d94c8954e46c491c40f0fcc9c9231caf20ca8e6f0e7d3/flinx-0.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f685e213d1d7ad391689d5aa31cc50e0",
                "sha256": "e93251cd396c0e1dab6e2f8a70b2d2a19aae7366b415c8d2f786eeb4a09936fe"
            },
            "downloads": -1,
            "filename": "flinx-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f685e213d1d7ad391689d5aa31cc50e0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 24619,
            "upload_time": "2018-06-17T19:45:50",
            "url": "https://files.pythonhosted.org/packages/28/4a/abd9a0d5315ee41411a2fa5c58fc7a71bf2d8a1b4ef0b6126df43430f9c9/flinx-0.2.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "65f873a230ee28e895009ee8ea417157",
                "sha256": "8966528c70b72ae2ea31bccc2c1e3fb2861ee26358ea8db3ded213f2792571ff"
            },
            "downloads": -1,
            "filename": "flinx-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "65f873a230ee28e895009ee8ea417157",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 18432,
            "upload_time": "2018-06-17T19:45:52",
            "url": "https://files.pythonhosted.org/packages/d4/ed/6c4010c53dcb348d94c8954e46c491c40f0fcc9c9231caf20ca8e6f0e7d3/flinx-0.2.0.tar.gz"
        }
    ]
}