{ "info": { "author": "Matthew Brett", "author_email": "matthew.brett@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: MacOS", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering" ], "description": "#######################################################\nSphinxtesters - utilities for testing Sphinx extensions\n#######################################################\n\n.. shared-text-body\n\n**********\nQuickstart\n**********\n\nIf you have a directory containing a sphinx project, test that it builds with\nsomething like:\n\n.. code:: python\n\n class TestMyProject(SourcesBuilder):\n\n page_source_template = 'path/to/sphinx_dir'\n\n def test_basic_build(self):\n # Get doctree for page \"a_page.rst\"\n doctree = self.get_doctree('a_page')\n # Assert stuff about doctree version of page\n html = self.get_built_file('a_page.html')\n # Assert stuff about html version of page\n\nYou can try adding other page content by using the ``rst_sources`` dictionary:\n\n.. code:: python\n\n class TestChangedProject(SourcesBuilder):\n\n page_source_template = 'path/to/sphinx_dir'\n rst_sources = {'a_page': \"\"\"Replacement text for page\"\"\",\n 'b_page': \"\"\"An entirely new page\"\"\"}\n\n def test_basic_build(self):\n a_doctree = self.get_doctree('a_page')\n b_doctree = self.get_doctree('b_page')\n # Your tests for the new page content here\n\nSet the text of the ``conf.py`` file with the ``conf_source`` attribute:\n\n.. code:: python\n\n class TestConfeddProject(SourcesBuilder):\n\n page_source_template = 'path/to/sphinx_dir'\n rst_sources = {'a_page': \"\"\"Replacement text for page\"\"\",\n 'b_page': \"\"\"An entirely new page\"\"\"}\n conf_source = \"\"\" # This overwrites existing conf.py \"\"\"\n\n def test_basic_build(self):\n a_doctree = self.get_doctree('a_page')\n b_doctree = self.get_doctree('b_page')\n # Your tests for the new page content here\n\nYou don't need to set ``page_source_template``; if you don't, you start with a\nfresh project, where the only pages are the ones you specify in\n``rst_sources``.\n\n.. code:: python\n\n class TestFreshProject(SourcesBuilder):\n\n rst_sources = {'a_page': \"\"\"A new page\"\"\",\n 'b_page': \"\"\"Another new page\"\"\"}\n conf_source = \"\"\" # Stuff for the conf.py file \"\"\"\n\n def test_basic_build(self):\n a_doctree = self.get_doctree('a_page')\n b_doctree = self.get_doctree('b_page')\n # Your tests for the new page content here\n\nSee the tests for examples of using Sphinxtesters for testing builds of Sphinx\nprojects.\n\n************\nInstallation\n************\n\n::\n\n pip install sphinxtesters\n\n****\nCode\n****\n\nSee https://github.com/matthew-brett/sphinxtesters\n\nReleased under the BSD two-clause license - see the file ``LICENSE`` in the\nsource distribution.\n\n`travis-ci `_ kindly tests the\ncode automatically under Python versions 2.7, and 3.3 through 3.6.\n\nThe latest released version is at https://pypi.python.org/pypi/sphinxtesters\n\n*****\nTests\n*****\n\n* Install ``sphinxtesters``\n* Install the pytest_ testing framework::\n\n pip install pytest\n\n* Run the tests with::\n\n pytest sphinxtesters\n\n*******\nSupport\n*******\n\nPlease put up issues on the `sphinxtesters issue tracker`_.\n\n.. standalone-references\n\n.. |sphinxtesters-documentation| replace:: `sphinxtesters documentation`_\n.. _sphinxtesters documentation:\n https://matthew-brett.github.com/sphinxtesters/sphinxtesters.html\n.. _documentation: https://matthew-brett.github.com/sphinxtesters\n.. _pandoc: http://pandoc.org\n.. _jupyter: jupyter.org\n.. _homebrew: brew.sh\n.. _sphinx: http://sphinx-doc.org\n.. _rest: http://docutils.sourceforge.net/rst.html\n.. _sphinxtesters issue tracker: https://github.com/matthew-brett/sphinxtesters/issues\n.. _pytest: https://pytest.org\n.. _mock: https://github.com/testing-cabal/mock", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/matthew-brett/sphinxtesters", "keywords": "", "license": "BSD license", "maintainer": "Matthew Brett", "maintainer_email": "matthew.brett@gmail.com", "name": "sphinxtesters", "package_url": "https://pypi.org/project/sphinxtesters/", "platform": "", "project_url": "https://pypi.org/project/sphinxtesters/", "project_urls": { "Homepage": "http://github.com/matthew-brett/sphinxtesters" }, "release_url": "https://pypi.org/project/sphinxtesters/0.2.3/", "requires_dist": null, "requires_python": "", "summary": "Utilities for testing Sphinx extensions", "version": "0.2.3" }, "last_serial": 5645082, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "454ef8159c4ba99bc1ebc2db67f30749", "sha256": "845cbe9a46086006dc055a2fb02ee2b515189baeb1ba9ab8bef0eef95070c5b1" }, "downloads": -1, "filename": "sphinxtesters-0.1.zip", "has_sig": true, "md5_digest": "454ef8159c4ba99bc1ebc2db67f30749", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34065, "upload_time": "2017-08-12T22:36:42", "url": "https://files.pythonhosted.org/packages/78/67/76daf8d3d68f9ef8082ab01e8c7a8de87c0942aaf21e44a672c699e56381/sphinxtesters-0.1.zip" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "5f732941254c02b68ba1b6a074cec8e6", "sha256": "0ba0a366436165ec5920c736ed757b49ff29dbd3e4133eeb09d7aaede0867860" }, "downloads": -1, "filename": "sphinxtesters-0.1.1.zip", "has_sig": true, "md5_digest": "5f732941254c02b68ba1b6a074cec8e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 34240, "upload_time": "2017-08-31T16:23:14", "url": "https://files.pythonhosted.org/packages/de/a1/b94c6f41c4a157ee47d00a14dee9534368776776c34bb6bcc92c4e4b822e/sphinxtesters-0.1.1.zip" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "cf10701bf2d5606d15bf6c7638bf5b4e", "sha256": "3268b972402d1ccd10ead984170b26fb5ac8e1b654fb14c47cde100011ed2296" }, "downloads": -1, "filename": "sphinxtesters-0.2.tar.gz", "has_sig": true, "md5_digest": "cf10701bf2d5606d15bf6c7638bf5b4e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28236, "upload_time": "2018-07-31T00:35:16", "url": "https://files.pythonhosted.org/packages/0b/07/97815206b545fa061944f046f84a31a24ad1822948798a47c5160bc489d9/sphinxtesters-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "bb7f2e4d0b836ce81b3e0ee8a221801c", "sha256": "50874652b2e166eca6ef5141181be5ade242d15201cabd39715dc277afdd9348" }, "downloads": -1, "filename": "sphinxtesters-0.2.1.tar.gz", "has_sig": true, "md5_digest": "bb7f2e4d0b836ce81b3e0ee8a221801c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28351, "upload_time": "2018-08-22T16:04:18", "url": "https://files.pythonhosted.org/packages/65/ff/87c1ca29312eba3646cb4235bc39c91977e3d46beb015b50f4238db264a6/sphinxtesters-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "11f8a4678f025f575078b64be52fc8d4", "sha256": "cd2e7f762cadaa0426cbeb1d49c36182f235f2ee660c6b155cf71976ee7f76a6" }, "downloads": -1, "filename": "sphinxtesters-0.2.2.tar.gz", "has_sig": true, "md5_digest": "11f8a4678f025f575078b64be52fc8d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 28868, "upload_time": "2019-08-07T00:07:40", "url": "https://files.pythonhosted.org/packages/1e/de/39e3a7442d385781da253744f37f6a8ee0546c5c8ccda22ad4d6c29e7a8e/sphinxtesters-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "3df3720ba757d3d8270fed5aff622852", "sha256": "0b3a22cb299c48728759e3138edc2c5188f74d8e7fdd3cd57b307060ccea9d4c" }, "downloads": -1, "filename": "sphinxtesters-0.2.3.tar.gz", "has_sig": true, "md5_digest": "3df3720ba757d3d8270fed5aff622852", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29166, "upload_time": "2019-08-07T13:24:40", "url": "https://files.pythonhosted.org/packages/23/35/1c4d8d18ab8585063c65d8aa5abcc3ca2a68b852a473fa98d773f9e43c8e/sphinxtesters-0.2.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3df3720ba757d3d8270fed5aff622852", "sha256": "0b3a22cb299c48728759e3138edc2c5188f74d8e7fdd3cd57b307060ccea9d4c" }, "downloads": -1, "filename": "sphinxtesters-0.2.3.tar.gz", "has_sig": true, "md5_digest": "3df3720ba757d3d8270fed5aff622852", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29166, "upload_time": "2019-08-07T13:24:40", "url": "https://files.pythonhosted.org/packages/23/35/1c4d8d18ab8585063c65d8aa5abcc3ca2a68b852a473fa98d773f9e43c8e/sphinxtesters-0.2.3.tar.gz" } ] }