{ "info": { "author": "Isaac Lenton", "author_email": "isaac@isuniversal.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "# sphinx-matlabdoc-builder\n\n[![Build Status](https://travis-ci.org/ilent2/sphinx-matlabdoc-builder.svg?branch=master)](https://travis-ci.org/ilent2/sphinx-matlabdoc-builder)\n\nA Sphinx extension for generating Matlab HTML docs.\nThis extension builds the Sphinx project into a set of HTML\ndocuments and additionally generates the TOC `helptoc.xml` file\nrequired for the\n[Matlab toolbox documentation](https://au.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html)\n\nFor generating documentation for Matlab code, check out the\n[matlabdomain](https://github.com/sphinx-contrib/matlabdomain) Sphinx extension.\n\n## Installation\n\nThe package can be installed from [Pip](https://pypi.org/project/sphinx-matlabdoc-builder/)\n\n```bash\npip install sphinx-matlabdoc-builder\n```\n\nAlternatively you can download the `sphinx_matlabdoc_builder` package into your\nsphinx directory and add the local directory to the sphinx path.\n\n## Requirements\nThis package is an extension to Sphinx.\nRequires Python 3.\n\n## Usage\n\nTo use sphinx-matlabdoc-builder, you must first install the package and add\nthe extension to your sphinx `conf.py` file. For example, add the\n`sphinx_matlabdoc_builder` extension to the end of your extension list:\n\n```python\nextensions = [\n 'sphinx.ext.mathjax',\n 'sphinx.ext.githubpages',\n 'sphinx_matlabdoc_builder',\n]\n```\n\nThen compile the source with\n\n```bash\nmake matlabdoc\n```\n\nor if using `sphinx-build`\n\n```\nsphinx-build -M matlabdoc ./ build\n```\n\nthis should generate the normal HTML output and add the `helptoc.xml`\nfile to the output directory.\n\nTo use the `helptoc.xml` file in your toolbox, create a new matlab\npackage and click add documentation and specify the documentation\noutput directory.\nIf you have an existing `info.xml` file, simply change the documentation\ndirectory to point to the output directory containing the `helptoc.xml` file.\nFor example, on Matlab 2018a, a `info.xml` file might look something like:\n\n```xml\n\n\n 2018a\n otslm\n toolbox\n \n docs\\_build\\matlabdoc\n \n\n```\n\nwhere `help_location` specifies the path to the Sphinx output directory.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://pypi.org/project/sphinx-matlabdoc-builder", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ilent2/sphinx-matlabdoc-builder", "keywords": "sphinx docs documentation matlab", "license": "BSD", "maintainer": "Isaac Lenton", "maintainer_email": "isaac@isuniversal.com", "name": "sphinx-matlabdoc-builder", "package_url": "https://pypi.org/project/sphinx-matlabdoc-builder/", "platform": "any", "project_url": "https://pypi.org/project/sphinx-matlabdoc-builder/", "project_urls": { "Download": "https://pypi.org/project/sphinx-matlabdoc-builder", "Homepage": "https://github.com/ilent2/sphinx-matlabdoc-builder" }, "release_url": "https://pypi.org/project/sphinx-matlabdoc-builder/0.1.2/", "requires_dist": [ "Sphinx (>=1.7.2)" ], "requires_python": "", "summary": "A Sphinx extension for generating Matlab HTML docs.", "version": "0.1.2" }, "last_serial": 5970164, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c9c63b1525c0b682aef9370f88300c2e", "sha256": "d35b14c28efb1c438caccbf30594e53caddbbd9d191f4d3207926f2b79b32b54" }, "downloads": -1, "filename": "sphinx_matlabdoc_builder-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c9c63b1525c0b682aef9370f88300c2e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4954, "upload_time": "2019-10-13T21:59:02", "url": "https://files.pythonhosted.org/packages/d8/6b/d5bec415d23543f827c5a74c041f683249e12a89951d8ec68006255de121/sphinx_matlabdoc_builder-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e4b898c0060c6eee77e1a9ea14dc3b4f", "sha256": "4c902703bc7bed0075d610b1db35fde605901c2436c0b2158df2687f94d6e617" }, "downloads": -1, "filename": "sphinx-matlabdoc-builder-0.1.0.tar.gz", "has_sig": false, "md5_digest": "e4b898c0060c6eee77e1a9ea14dc3b4f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3184, "upload_time": "2019-10-13T21:59:05", "url": "https://files.pythonhosted.org/packages/2e/fe/0484ffe4729a2b0155f564798b4a04d28fbbec636ce6576b2da4f5eeed34/sphinx-matlabdoc-builder-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9a95721e199174e2fb71a48d2658ef7b", "sha256": "e7ac5a895d038d5cd3691634a876d584545b469807f197de02c4137552b88457" }, "downloads": -1, "filename": "sphinx_matlabdoc_builder-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9a95721e199174e2fb71a48d2658ef7b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5656, "upload_time": "2019-10-14T04:48:30", "url": "https://files.pythonhosted.org/packages/8e/6e/46e0b6e075ebdfbce490539112cabce6e85161b31d46ea0de192d152c9f5/sphinx_matlabdoc_builder-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4f8652497bb30725bc2ad87655c47788", "sha256": "bd122f03143b96b0707ce8a9d2b372e3ca0b711dd6183d06035958c402d9ef28" }, "downloads": -1, "filename": "sphinx-matlabdoc-builder-0.1.1.tar.gz", "has_sig": false, "md5_digest": "4f8652497bb30725bc2ad87655c47788", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4041, "upload_time": "2019-10-14T04:48:34", "url": "https://files.pythonhosted.org/packages/92/cb/b2b8934856912e3bef0e2f1c26f3a4d89877448423065ca9d8895d4dd4f6/sphinx-matlabdoc-builder-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "aef41a7edb6fa52f93b91150f87fc04e", "sha256": "21f56d30835925a319f7a65608c3974443458589d5721a3ad1a4f84665c5532a" }, "downloads": -1, "filename": "sphinx_matlabdoc_builder-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "aef41a7edb6fa52f93b91150f87fc04e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5662, "upload_time": "2019-10-14T07:00:01", "url": "https://files.pythonhosted.org/packages/28/46/3068079ea46e562f859c8ec71f2ad2c7c7d14f798975903f5bd97b797a78/sphinx_matlabdoc_builder-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae65cac8912d922ba2d37d0789207cab", "sha256": "5519f5ace6967404efa264cdfb95b9810b4e8561b8413834e773314740575d80" }, "downloads": -1, "filename": "sphinx-matlabdoc-builder-0.1.2.tar.gz", "has_sig": false, "md5_digest": "ae65cac8912d922ba2d37d0789207cab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4043, "upload_time": "2019-10-14T07:00:02", "url": "https://files.pythonhosted.org/packages/54/a9/1c1000c8415a3b55c01550e257efb04b364232b786f5f43a765764acf1a6/sphinx-matlabdoc-builder-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aef41a7edb6fa52f93b91150f87fc04e", "sha256": "21f56d30835925a319f7a65608c3974443458589d5721a3ad1a4f84665c5532a" }, "downloads": -1, "filename": "sphinx_matlabdoc_builder-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "aef41a7edb6fa52f93b91150f87fc04e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5662, "upload_time": "2019-10-14T07:00:01", "url": "https://files.pythonhosted.org/packages/28/46/3068079ea46e562f859c8ec71f2ad2c7c7d14f798975903f5bd97b797a78/sphinx_matlabdoc_builder-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae65cac8912d922ba2d37d0789207cab", "sha256": "5519f5ace6967404efa264cdfb95b9810b4e8561b8413834e773314740575d80" }, "downloads": -1, "filename": "sphinx-matlabdoc-builder-0.1.2.tar.gz", "has_sig": false, "md5_digest": "ae65cac8912d922ba2d37d0789207cab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4043, "upload_time": "2019-10-14T07:00:02", "url": "https://files.pythonhosted.org/packages/54/a9/1c1000c8415a3b55c01550e257efb04b364232b786f5f43a765764acf1a6/sphinx-matlabdoc-builder-0.1.2.tar.gz" } ] }