{ "info": { "author": "Yoav Ram", "author_email": "yoav@yoavram.com", "bugtrack_url": null, "classifiers": [], "description": "# Golden Sphinx\n\nBuild and serve Sphinx docs.\n\nExample usage:\n\n```sh\n$ goldensphinx build serve\n```\n\nYou can also just build:\n\n```sh\n$ goldensphinx build\n```\n\nor just serve:\n\n```sh\n$ goldensphinx serve\n```\n\nTo see the options you can control, run a command with `--help`:\n\n```sh\n$ goldensphinx build --help\nUsage: goldensphinx build [OPTIONS]\n\nOptions:\n --source_dir PATH Directory containing documentation source\n --dest_dir PATH Directory to build documentation to\n --help Show this message and exit.\n\n$ goldensphinx serve --help\nUsage: goldensphinx serve [OPTIONS]\n\nOptions:\n --static_dir PATH Static directory to serve\n --host TEXT Hostname to serve on\n --port INTEGER Port to serve on\n --threads INTEGER Number of threads\n --help Show this message and exit.\n```\n\nAll options can be also be set using environment variables:\n\n- `source_dir` and `static_dir` by `STATIC_DIR`\n- `dest_dir` by `DOCS_DIR`\n- `port` by `PORT`\n- `host` by `HOST`\n- `threads` by `NUM_SERVER_THREADS`\n\nFor example:\n\n```sh\n$ export PORT=8080\n$ goldensphinx serve --host 127.0.0.1\n[2016-09-06 10:02:14 +0300] [55096] [INFO] Starting gunicorn 19.6.0\n[2016-09-06 10:02:14 +0300] [55096] [INFO] Listening at: http://127.0.0.1:8080 (87302)\n```\n\nYou can also set the environment variable `GOLDENSPHINX` to `false` if you want to prevent goldensphinx from running.\n\n## Install\n\nStable:\n\n```sh\npip install goldensphinx\n```\n\nLatest:\n\n```sh\npip install git+https://github.com/yoavram/goldensphinx.git\n```\n\n## Authors\n\n- Yoav Ram (@yoavram)\n\n## Acknowledgements\n\n- The project is inspired by, and the `serve` command is modified from [kennethreitz/goldenarch](https://github.com/kennethreitz/goldenarch).\n- Many thanks to the authors of Python, Gunicorn, Sphinx, Click, Static and everything else we build our apps with.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yoavram/goldensphinx", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "goldensphinx", "package_url": "https://pypi.org/project/goldensphinx/", "platform": "", "project_url": "https://pypi.org/project/goldensphinx/", "project_urls": { "Homepage": "https://github.com/yoavram/goldensphinx" }, "release_url": "https://pypi.org/project/goldensphinx/0.0.3/", "requires_dist": [ "click (>=5sphinx>=1.3.0)", "gevent (>=0.13.6)", "greenlet (>=0.3.1)", "gunicorn (>=0.13.4)", "numpydoc", "sphinx-rtd-theme", "static", "static (>=0.4)" ], "requires_python": "", "summary": "Build and serve Sphinx", "version": "0.0.3" }, "last_serial": 2348672, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "a15401ed13c810388310b6fbd4a19ebf", "sha256": "8c83932366529e5e6f62f780b3efc9a4793af962d2c42c5f2f50cb6bc006b077" }, "downloads": -1, "filename": "goldensphinx-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a15401ed13c810388310b6fbd4a19ebf", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5584, "upload_time": "2016-09-11T05:36:43", "url": "https://files.pythonhosted.org/packages/6b/3d/94d916aaa11fb8421a6008b503a40ea442d00feb88c1722aa79ff86eb0ba/goldensphinx-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "77208f03ee987fd43d713616d0a4d0a3", "sha256": "85beda050f1882a3d9d676bab1effc327f2ff15e44fd6eaffd4967e1e66a7e89" }, "downloads": -1, "filename": "goldensphinx-0.0.1.tar.gz", "has_sig": false, "md5_digest": "77208f03ee987fd43d713616d0a4d0a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18642, "upload_time": "2016-09-11T05:36:46", "url": "https://files.pythonhosted.org/packages/72/ca/54b2ffec316c3921ebd74b1be64029141ea1bd7ea62e85f20e26dc8a7be2/goldensphinx-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "0a56adc118aa7c5c49e97a3621ed693f", "sha256": "038d9e1aca96e0198021c0d8f083091605ec8a06021a33f5a86a4c9b3e132001" }, "downloads": -1, "filename": "goldensphinx-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0a56adc118aa7c5c49e97a3621ed693f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5698, "upload_time": "2016-09-11T05:46:20", "url": "https://files.pythonhosted.org/packages/7f/66/3f1e394ddff355c724fc4de77a38377df79787018e93fa65582e2bdb23b8/goldensphinx-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3261c5546d19602e5ff459d436071eb2", "sha256": "0a0a1c2e0dc143ea1e004f30a9ddaf9f4d0e68b25af710a702ce41dd9c28b665" }, "downloads": -1, "filename": "goldensphinx-0.0.2.tar.gz", "has_sig": false, "md5_digest": "3261c5546d19602e5ff459d436071eb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18693, "upload_time": "2016-09-11T05:46:22", "url": "https://files.pythonhosted.org/packages/76/3c/177e5ff7b6f872daf847db8a406ace352a49553f7f21d078cce5a6aa1ef6/goldensphinx-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "d5a678ebfc107bec3f2068724ded4f4b", "sha256": "9f62d878e39c6270985a0d5fbc11ad38051d330a497c3dab1a2b18724e2412a0" }, "downloads": -1, "filename": "goldensphinx-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d5a678ebfc107bec3f2068724ded4f4b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5685, "upload_time": "2016-09-18T05:40:12", "url": "https://files.pythonhosted.org/packages/6e/9d/ae11940ca73466c1e7e0cab87e2fa2619d8ff6183608bf5709c5b02f9b4d/goldensphinx-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e904fe977a6ef077b50b45cdeff367a", "sha256": "f254daef9437e97b5f6b9da3a42bb1d25c9270ac81793fd1e99a2dbfaa6ec65d" }, "downloads": -1, "filename": "goldensphinx-0.0.3.tar.gz", "has_sig": false, "md5_digest": "3e904fe977a6ef077b50b45cdeff367a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18692, "upload_time": "2016-09-18T05:40:15", "url": "https://files.pythonhosted.org/packages/2b/41/992b1e56eb60737986c7b1f7e80977bc58402b41f9e3fb49c15a83ab63de/goldensphinx-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d5a678ebfc107bec3f2068724ded4f4b", "sha256": "9f62d878e39c6270985a0d5fbc11ad38051d330a497c3dab1a2b18724e2412a0" }, "downloads": -1, "filename": "goldensphinx-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d5a678ebfc107bec3f2068724ded4f4b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5685, "upload_time": "2016-09-18T05:40:12", "url": "https://files.pythonhosted.org/packages/6e/9d/ae11940ca73466c1e7e0cab87e2fa2619d8ff6183608bf5709c5b02f9b4d/goldensphinx-0.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3e904fe977a6ef077b50b45cdeff367a", "sha256": "f254daef9437e97b5f6b9da3a42bb1d25c9270ac81793fd1e99a2dbfaa6ec65d" }, "downloads": -1, "filename": "goldensphinx-0.0.3.tar.gz", "has_sig": false, "md5_digest": "3e904fe977a6ef077b50b45cdeff367a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18692, "upload_time": "2016-09-18T05:40:15", "url": "https://files.pythonhosted.org/packages/2b/41/992b1e56eb60737986c7b1f7e80977bc58402b41f9e3fb49c15a83ab63de/goldensphinx-0.0.3.tar.gz" } ] }