{ "info": { "author": "Jean-Philippe Camguilhem", "author_email": "jean-philippe.camguilhem__at__makina-corpus.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "=======================\nsphinxcontrib-gen_node\n=======================\n\nA generic \"todo like\" nodes.\n\nYou love sphinx-ext-todo, and want more directives like this ?\n\nThis extension is for you.\n\n\n`install me`_ with zc.buildout| pip | easy_install or clone and setup.py install|develop and add this to your conf.py ::\n \n extensions = ['sphinxcontrib.gen_node'] \n gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False),]\n\n\nexplanations \n=============\n\ngen_nodes is a list of tuples which for each element you could now add in your documentation like you do with 'sphinx-ext-todo':\n\n* a new sample_one directive ::\n\n .. sample_one:: one thing\n \n\n\n\n* a new sample_onelist directive ::\n \n .. sample_onelist::\n\n \n\nThe sample_onelist will not appear in your documentation if you set False in your conf.py gen_nodes = [('sample_one', False, False, False),... on the second argument.\n\noptions :\n\n + sample_one is the name of your new admonition, you'll write ::\n\n .. sample_one:: A text here\n\n + The first (True|False) argument enables the list Plz note that the form of a \"list directive is always 'namenode'+list ie ::\n\n .. sample_onelist:: \n\n + the second (True|False) renders gathering by doc subtitle \n\n + the third (True|False) renders a paragraph with filename and line number (like on todo-list) with sphinxext.todo \n\n\n\n_`install me`\n=============\n\neasy_install ::\n \n easy_install sphinxcontrib-gen_node\n \n\npip ::\n \n pip install Sphinx\n pip sphinxcontrib-gen_node\n\nzc.buildout ::\n\n eggs =\n Sphinx\n sphinxcontrib-gen_node\n\n\nupdate your source/conf.py::\n\n extensions = ['sphinxcontrib.gen_node'] \n gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False)] \n\n\nCredits\n========\nCompanies\n---------\n|makinacom|_\n\n * `Planet Makina Corpus `_\n * `Contact us `_\n\n .. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif\n .. _makinacom: http://www.makina-corpus.com\n\n\n\n\nChangelog\n=========\n\n0.1 (2013-10-31)\n----------------\n\n- Jean-Philippe Camguilhem \n\n\nContributors\n==============\n\nJean-Philippe Camguilhem, Author", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-gen_node", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jpcw/sphinxcontrib-gen_node", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-gen_node", "package_url": "https://pypi.org/project/sphinxcontrib-gen_node/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-gen_node/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-gen_node", "Homepage": "https://github.com/jpcw/sphinxcontrib-gen_node" }, "release_url": "https://pypi.org/project/sphinxcontrib-gen_node/0.1-20131031/", "requires_dist": null, "requires_python": null, "summary": "Sphinx generic nodes \"todo like\" extension", "version": "0.1-20131031" }, "last_serial": 908324, "releases": { "0.1-20131031": [ { "comment_text": "", "digests": { "md5": "2c2bb8082737b78088799f0867550223", "sha256": "4f4d6e62facbe81a28d33ec06b3685679d2302ee4b66b84af85a487ed1568187" }, "downloads": -1, "filename": "sphinxcontrib-gen_node-0.1-20131031.zip", "has_sig": false, "md5_digest": "2c2bb8082737b78088799f0867550223", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12034, "upload_time": "2013-10-31T15:27:08", "url": "https://files.pythonhosted.org/packages/e6/fe/9e3d354cfb43e0a52f0dbe830faf6ec710b66d97a0c862dfb1ad78d8bdb9/sphinxcontrib-gen_node-0.1-20131031.zip" } ], "0.1.dev0dev-20131031": [] }, "urls": [ { "comment_text": "", "digests": { "md5": "2c2bb8082737b78088799f0867550223", "sha256": "4f4d6e62facbe81a28d33ec06b3685679d2302ee4b66b84af85a487ed1568187" }, "downloads": -1, "filename": "sphinxcontrib-gen_node-0.1-20131031.zip", "has_sig": false, "md5_digest": "2c2bb8082737b78088799f0867550223", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12034, "upload_time": "2013-10-31T15:27:08", "url": "https://files.pythonhosted.org/packages/e6/fe/9e3d354cfb43e0a52f0dbe830faf6ec710b66d97a0c862dfb1ad78d8bdb9/sphinxcontrib-gen_node-0.1-20131031.zip" } ] }