{ "info": { "author": "Thomas Mansencal", "author_email": "thomas.mansencal@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Utilities" ], "description": "Oncilla\n=======\n\n.. image:: https://secure.travis-ci.org/KelSolaar/Oncilla.png?branch=master\n.. image:: https://gemnasium.com/KelSolaar/Oncilla.png\n\nIntroduction\n------------\n\n**Oncilla** is the documentation building helper package of `Oncilla `_, `Manager `_, `Umbra `_, `sIBL_GUI `_ and `sIBL_Reporter `_.\n\nInstallation\n------------\n\nThe following dependencies are needed:\n\n- **Python 2.6.7** or **Python 2.7.3**: http://www.python.org/\n- **PyQt**: http://www.riverbankcomputing.co.uk/\n- **Tidy** http://tidy.sourceforge.net/\n\nTo install **Oncilla** from the `Python Package Index `_ you can issue this command in a shell::\n\n\tpip install Oncilla\n\nor this alternative command::\n\n\teasy_install Oncilla\n\nYou can also directly install from `Github `_ source repository::\n\n\tgit clone git://github.com/KelSolaar/Oncilla.git\n\tcd Oncilla\n\tpython setup.py install\n\nUsage\n-----\n\nIn order to build the project documentation, **Oncilla** needs some prerequisites.\n\n_`Prerequisites`\n++++++++++++++++\n\n_`Environment`\n^^^^^^^^^^^^^^\n\nYou will need to have the following environment variables defined:\n\n- **ONCILLA_PROJECT_DIRECTORY**: Defines the project directory you want to build the manual and **Sphinx** documentation.\n- **ONCILLA_PROJECT_NAME**: Defines the name you want to use across the manual and **Sphinx** documentation files.\n- **ONCILLA_PROJECT_PACKAGES**: Defines the packages you want to build the **Sphinx** documentation.\n- **ONCILLA_PROJECT_SANITIZER**: Defines the optional **Sphinx** documentation sanitizing **Python** module.\n- **ONCILLA_PROJECT_EXCLUDED_MODULES**: Defines the optional excluded **Python** modules from **Sphinx** documentation.\n- **ONCILLA_PROJECT_MANUAL_CSS_FILE**: Defines the optional **css** stylesheet file used for the manual.\n\nExample::\n\n export ONCILLA_PROJECT_DIRECTORY=\"/Users/kelsolaar/Documents/Development/sIBL_GUI\"\n export ONCILLA_PROJECT_NAME=\"sIBL_GUI\"\n export ONCILLA_PROJECT_PACKAGES=\"oncilla foundations manager umbra sibl_gui\"\n export ONCILLA_PROJECT_SANITIZER=\"/Users/kelsolaar/Documents/Development/sIBL_GUI/utilities/sanitizer.py\"\n export ONCILLA_PROJECT_EXCLUDED_MODULES=\"pyclbr tests 001_dummy 001_migrate_3-x-x_to_4-0-0 002_migrate_4-x-x_to_4-0-2 003_migrate_4-x-x_to_4-0-3 004_migrate_4-x-x_to_4-0-7 defaultScript\"\n\n_`Paths`\n^^^^^^^^\n\n**Oncilla** documentation is built with itself and is a good reference on how to structure your project documentation directories.\n\nAssuming **$PROJECT_NAME** is the project name and **$PROJECT_DIRECTORY** the project root directory, the following paths need to be defined:\n\n- **$PROJECT_DIRECTORY/docs/help/$PROJECT_NAME_Manual.rst**: Source manual **reStructuredText** file.\n- **$PROJECT_DIRECTORY/docs/sphinx**: Standard **Sphinx** documentation root directory containing the **Makefile** and **source/conf.py** files.\n\n_`Slicing`\n++++++++++\n\nThe **Sphinx** documentation pages are generated by slicing the source manual **reStructuredText** file using specific tags prepended by a dot ( **.** )::\n\n E.g.: .. .mySliceTag\n\nFor example, https://github.com/KelSolaar/Oncilla/blob/master/docs/help/Oncilla_Manual.rst file defines various tags like *.. .tocTree*, *.. .introduction*, *.. .installation*, etc..., and as a result the *tocTree.rst*, *introduction.rst*, *installation.rst* pages will be created and included into the **Sphinx** documentation.\n \n_`Execution`\n++++++++++++\n\nOnce the prerequisites have been defined, you can launch **Oncilla** using this shell command::\n\n Oncilla\n\nAbout\n-----\n\n| **Oncilla** by Thomas Mansencal \u2013 2008 - 2014\n| Copyright\u00a9 2008 - 2014 \u2013 Thomas Mansencal \u2013 `thomas.mansencal@gmail.com `_\n| This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/\n| `http://www.thomasmansencal.com/ `_", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/KelSolaar/Oncilla", "keywords": null, "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "Oncilla", "package_url": "https://pypi.org/project/Oncilla/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/Oncilla/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/KelSolaar/Oncilla" }, "release_url": "https://pypi.org/project/Oncilla/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Oncilla is the documentation building helper package of Oncilla, Color, Manager, Umbra, sIBL_GUI and sIBL_Reporter.", "version": "0.1.0" }, "last_serial": 1050800, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "8214bf83c2c7589b5b8f78658cfd875d", "sha256": "24f81789205dc8c87a9d849982320dcab7d4d83284194aae5e9597781c287aa3" }, "downloads": -1, "filename": "Oncilla-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8214bf83c2c7589b5b8f78658cfd875d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 673986, "upload_time": "2014-04-03T22:06:12", "url": "https://files.pythonhosted.org/packages/cc/b0/70508c96ab1d7e9a77a943f421f8684e471a469b81f235d842f0da50570f/Oncilla-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8214bf83c2c7589b5b8f78658cfd875d", "sha256": "24f81789205dc8c87a9d849982320dcab7d4d83284194aae5e9597781c287aa3" }, "downloads": -1, "filename": "Oncilla-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8214bf83c2c7589b5b8f78658cfd875d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 673986, "upload_time": "2014-04-03T22:06:12", "url": "https://files.pythonhosted.org/packages/cc/b0/70508c96ab1d7e9a77a943f421f8684e471a469b81f235d842f0da50570f/Oncilla-0.1.0.tar.gz" } ] }