{ "info": { "author": "Gael Pasgrimaud", "author_email": "gael@gawel.org", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "License :: OSI Approved :: GNU General Public License (GPL)", "Operating System :: OS Independent", "Topic :: Utilities" ], "description": ".. contents::\n\nDescription\n===========\n\n``rstctl`` is a script to help you with reStructuredText_\n\nUsage\n=====\n\nHTML preview\n------------\n\nYou can preview a file::\n\n $ rstctl -w path/to/file.rst\n\nOr the long description of a package::\n\n $ ls setup.py\n setup.py\n\n $ rstctl -w\n\nThis will open the result in your favorite browser.\n\nCheck links\n-----------\n\nYou can use the `-l` option to add unknown references to the end of a document.\nExample::\n\n $ cat README.txt \n Title\n =====\n\n `incomplete ref`_\n\n $ ./bin/rstctl -l README.txt \n :4: (ERROR/3) Unknown target name: \"incomplete ref\".\n\n\n .. _incomplete ref: \n\n\n 1 links append to README.txt\n $ cat README.txt \n Title\n =====\n\n `incomplete ref`_\n\n\n .. _incomplete ref: \n\nThen you can add the correct links.\n\nGenerating Sphinx documentation\n--------------------------------\n\nGo to the package root then use the ``--sphinx`` option::\n\n $ rstctl --sphinx docs/conf.py \n Using /Users/gawel/py/rstctl/rstctl/module.tmpl\n Writing docs/modules/rstctl.txt\n Skipping rstctl.pdf excluded by conf.py\n Skipping rstctl.rst_directive excluded by conf.py\n Using /Users/gawel/py/rstctl/rstctl/module.tmpl\n Writing docs/modules/rstctl.serve.txt\n Using /Users/gawel/py/rstctl/rstctl/module.tmpl\n Writing docs/modules/rstctl.template.txt\n Using /Users/gawel/py/rstctl/rstctl/module.tmpl\n Writing docs/modules/rstctl.utils.txt\n Writing index\n\nAdd ``modules/index`` in a ``toctree`` \n\nIf you want to exclude some modules add this to your ``conf.py``::\n\n rstctl_exclude = ['rstctl.rst_directive', 'rstctl.pdf']\n\nYou can also add ``rstctl.sphinx`` in conf.py's extensions\n\n.. _reStructuredText: http://docutils.sourceforge.net/rst.html\n\n0.4 (2010-03-06)\n================\n\n- add ``--sphinx`` option + sphinx extension\n\n0.1 (2008-11-31)\n================\n\n- initial release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.gawel.org", "keywords": "reST", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "rstctl", "package_url": "https://pypi.org/project/rstctl/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rstctl/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://www.gawel.org" }, "release_url": "https://pypi.org/project/rstctl/0.4/", "requires_dist": null, "requires_python": null, "summary": "reST utils", "version": "0.4" }, "last_serial": 754524, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "8e622788423b3a31b8bec4e75604c738", "sha256": "f2145805fdfd387fa35107f8f918b4b781b1f10d820d0db809c31153b931b285" }, "downloads": -1, "filename": "rstctl-0.1.tar.gz", "has_sig": false, "md5_digest": "8e622788423b3a31b8bec4e75604c738", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3728, "upload_time": "2008-10-31T18:59:04", "url": "https://files.pythonhosted.org/packages/2c/09/92b42090c501c3e3b27f1873c8d25f8a43b1ac1fa2eedd0162ce3f4860db/rstctl-0.1.tar.gz" } ], "0.1dev-r1221": [ { "comment_text": "", "digests": { "md5": "bb4f7209b3c44b3031bf6d15ce18a950", "sha256": "18a84d4753fdfc7fe4b2a56120b85b1db8df368843960d0d11ba985d2baf4ba6" }, "downloads": -1, "filename": "rstctl-0.1dev-r1221.tar.gz", "has_sig": false, "md5_digest": "bb4f7209b3c44b3031bf6d15ce18a950", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3751, "upload_time": "2008-10-31T18:57:36", "url": "https://files.pythonhosted.org/packages/24/31/e7616dd098c20688125a902f8407a602e8929bbe251d13d67e2df2bd0cc3/rstctl-0.1dev-r1221.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "1f65d41e508e950a791a527613cb4679", "sha256": "5ddbdad255cc929bc111ccb9d5ac517b953b04fc0e50fcd618ef490f092a5292" }, "downloads": -1, "filename": "rstctl-0.2.tar.gz", "has_sig": false, "md5_digest": "1f65d41e508e950a791a527613cb4679", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6822, "upload_time": "2010-03-06T20:28:53", "url": "https://files.pythonhosted.org/packages/9e/99/8f867e1db1dc3ec17d9402429f351c104e746073c9fffff722d7e24f951a/rstctl-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "d2627ede87b094f2460a2c0f251fd82c", "sha256": "e80c3c6502ac3dcb14ea4c90afdb66b575b46f52b1fbff7c23c6839755c2a5aa" }, "downloads": -1, "filename": "rstctl-0.3.tar.gz", "has_sig": false, "md5_digest": "d2627ede87b094f2460a2c0f251fd82c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7180, "upload_time": "2010-03-06T20:52:05", "url": "https://files.pythonhosted.org/packages/77/60/b5b779be3a0caa9ba383e61b60d4350efc2a9ca26aae9d0b30dc1d771653/rstctl-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "d1f5d81638f3e0d249cbb029a36d4dd2", "sha256": "da7e6da6b3d222140beaf8380b89fd14903a0f2ccd2a13da5f3a03625e3467b9" }, "downloads": -1, "filename": "rstctl-0.4.tar.gz", "has_sig": false, "md5_digest": "d1f5d81638f3e0d249cbb029a36d4dd2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7487, "upload_time": "2010-03-06T21:58:55", "url": "https://files.pythonhosted.org/packages/95/65/abfa1e2c81bda1521c6d41116a0720ee68b17c8f57c2717473a24aa85a9a/rstctl-0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d1f5d81638f3e0d249cbb029a36d4dd2", "sha256": "da7e6da6b3d222140beaf8380b89fd14903a0f2ccd2a13da5f3a03625e3467b9" }, "downloads": -1, "filename": "rstctl-0.4.tar.gz", "has_sig": false, "md5_digest": "d1f5d81638f3e0d249cbb029a36d4dd2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7487, "upload_time": "2010-03-06T21:58:55", "url": "https://files.pythonhosted.org/packages/95/65/abfa1e2c81bda1521c6d41116a0720ee68b17c8f57c2717473a24aa85a9a/rstctl-0.4.tar.gz" } ] }