{"author":null,"author_email":"Jeremy Maitin-Shepard , Brendan <2bndy5@gmail.com>","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: Sphinx :: Extension","Framework :: Sphinx :: Theme","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Natural Language :: English","Programming Language :: Python","Topic :: Documentation :: Sphinx"],"description":"Sphinx-Immaterial Theme\n=======================\n\n|MIT License| |PyPI Package| |CI status| |codecov-badge|\n\nThis theme is an adaptation of the popular `mkdocs-material\n`__ theme for the `Sphinx\n`__ documentation tool.\n\nThis theme is regularly maintained to stay up to date with the upstream\n`mkdocs-material `__ repository.\nThe HTML templates, JavaScript, and styles from the `mkdocs-material\n`__ theme are incoroprated directly\nwith mostly minor modifications.\n\nThis theme is a fork of the `sphinx-material\n`__ theme, which proved the concept\nof a Sphinx theme based on an earlier version of the `mkdocs-material\n`__ theme, but has now\nsignificantly diverged from the upstream `mkdocs-material\n`__ repository.\n\nSee `this theme's own documentation\n`__ for a demonstration.\n\nWARNING: This theme is still in beta. While it is already very usable, breaking\nchanges will still be made prior to the 1.0 release.\n\nInstallation\n------------\n\nInstall via pip:\n\n.. code-block:: bash\n\n $ pip install sphinx-immaterial\n\nor if you have the code checked out locally:\n\n.. code-block:: bash\n\n $ pip install -e .\n\nConfiguration\n-------------\n\nIn your `conf.py` add `sphinx_immaterial` as an extension:\n\n.. code-block:: python\n\n extensions = [\n ...,\n \"sphinx_immaterial\"\n ]\n\nand add the following:\n\n.. code-block:: python\n\n html_theme = 'sphinx_immaterial'\n\nto set the theme.\n\nCustomizing the layout\n----------------------\n\nYou can customize the theme by overriding Jinja template blocks. For example,\n'layout.html' contains several blocks that can be overridden or extended.\n\nPlace a 'layout.html' file in your project's '/_templates' directory.\n\n.. code-block:: bash\n\n mkdir source/_templates\n touch source/_templates/layout.html\n\nThen, configure your 'conf.py':\n\n.. code-block:: python\n\n templates_path = ['_templates']\n\nFinally, edit your override file 'source/_templates/layout.html':\n\n::\n\n {# Import the theme's layout. #}\n {% extends '!layout.html' %}\n\n {%- block extrahead %}\n {# Add custom things to the head HTML tag #}\n {# Call the parent block #}\n {{ super() }}\n {%- endblock %}\n\nDifferences from mkdocs-material\n--------------------------------\n\nThis theme closely follows the upstream `mkdocs-material\n`__ repository, but there are a\nfew differences, primarily due to differences between Sphinx and MkDocs:\n\n- This theme adds styles for Sphinx object descriptions, commonly used for API\n documentation (e.g. class and function documentation). This is a core element\n of Sphinx for which there is no corresponding feature in MkDocs.\n\n- mkdocs-material uses `lunr.js `__ for searching, and has\n custom UI components for displaying search results in a drop-down menu as you\n type the search query. This theme uses a separate search implementation based\n on the custom index format used by Sphinx, which fully integrates with the\n search UI provided by mkdocs-material.\n\n.. |MIT License| image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: https://opensource.org/licenses/MIT-Clause\n\n.. |PyPI Package| image:: https://img.shields.io/pypi/v/sphinx-immaterial\n :target: https://pypi.org/project/sphinx-immaterial\n\n.. |CI status| image:: https://github.com/jbms/sphinx-immaterial/actions/workflows/build.yml/badge.svg\n :target: https://github.com/jbms/sphinx-immaterial/actions/workflows/build.yml\n\n.. |codecov-badge| image:: https://codecov.io/gh/jbms/sphinx-immaterial/graph/badge.svg?token=IGK0B3WN42\n :alt: codecov\n :target: https://codecov.io/gh/jbms/sphinx-immaterial\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":null,"keywords":null,"license":"Copyright 2021 The Sphinx-Immaterial Authors\n \n Derived from:\n * Sphinx-material: Copyright (c) 2019 Kevin Sheppard \n * Material for Mkdocs: Copyright (c) 2016-2019 Martin Donath \n * Guzzle Sphinx Theme: Copyright (c) 2013 Michael Dowling \n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is furnished\n to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\n WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n \n --------------------------------------------------------------------------------\n \n Files: sphinx_immaterial/cppreference_data/index-functions-{c,cpp}.xml\n \n Copyright (C) 2012 Povilas Kanapickas \n \n This work is licensed under the Creative Commons Attribution-ShareAlike 3.0\n Unported License. To view a copy of this license, visit\n http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative\n Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.\n \n Creative Commons Attribution-ShareAlike 3.0 Unported\n \n <> CREATIVE COMMONS CORPORATION IS NOT A LAW\n FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS LICENSE DOES NOT\n CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS\n INFORMATION ON AN \"AS-IS\" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING\n THE INFORMATION PROVIDED, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM ITS\n USE. <>\n \n License\n \n THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS\n PUBLIC LICENSE (\"CCPL\" OR \"LICENSE\"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR\n OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS\n LICENSE OR COPYRIGHT LAW IS PROHIBITED.\n \n BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE\n BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED\n TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN\n CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.\n \n 1. Definitions\n \n a. \"Adaptation\" means a work based upon the Work, or upon the Work and\n other pre-existing works, such as a translation, adaptation, derivative\n work, arrangement of music or other alterations of a literary or\n artistic work, or phonogram or performance and includes cinematographic\n adaptations or any other form in which the Work may be recast,\n transformed, or adapted including in any form recognizably derived from\n the original, except that a work that constitutes a Collection will not\n be considered an Adaptation for the purpose of this License. For the\n avoidance of doubt, where the Work is a musical work, performance or\n phonogram, the synchronization of the Work in timed-relation with a\n moving image (\"synching\") will be considered an Adaptation for the\n purpose of this License.\n \n b. \"Collection\" means a collection of literary or artistic works, such as\n encyclopedias and anthologies, or performances, phonograms or\n broadcasts, or other works or subject matter other than works listed in\n Section 1(f) below, which, by reason of the selection and arrangement of\n their contents, constitute intellectual creations, in which the Work is\n included in its entirety in unmodified form along with one or more other\n contributions, each constituting separate and independent works in\n themselves, which together are assembled into a collective whole. A work\n that constitutes a Collection will not be considered an Adaptation (as\n defined below) for the purposes of this License.\n \n c. \"Creative Commons Compatible License\" means a license that is listed at\n http://creativecommons.org/compatiblelicenses that has been approved by\n Creative Commons as being essentially equivalent to this License,\n including, at a minimum, because that license: (i) contains terms that\n have the same purpose, meaning and effect as the License Elements of\n this License; and, (ii) explicitly permits the relicensing of\n adaptations of works made available under that license under this\n License or a Creative Commons jurisdiction license with the same License\n Elements as this License.\n \n d. \"Distribute\" means to make available to the public the original and\n copies of the Work or Adaptation, as appropriate, through sale or other\n transfer of ownership.\n \n e. \"License Elements\" means the following high-level license attributes as\n selected by Licensor and indicated in the title of this License:\n Attribution, ShareAlike.\n \n f. \"Licensor\" means the individual, individuals, entity or entities that\n offer(s) the Work under the terms of this License.\n \n g. \"Original Author\" means, in the case of a literary or artistic work, the\n individual, individuals, entity or entities who created the Work or if\n no individual or entity can be identified, the publisher; and in\n addition (i) in the case of a performance the actors, singers,\n musicians, dancers, and other persons who act, sing, deliver, declaim,\n play in, interpret or otherwise perform literary or artistic works or\n expressions of folklore; (ii) in the case of a phonogram the producer\n being the person or legal entity who first fixes the sounds of a\n performance or other sounds; and, (iii) in the case of broadcasts, the\n organization that transmits the broadcast.\n \n h. \"Work\" means the literary and/or artistic work offered under the terms\n of this License including without limitation any production in the\n literary, scientific and artistic domain, whatever may be the mode or\n form of its expression including digital form, such as a book, pamphlet\n and other writing; a lecture, address, sermon or other work of the same\n nature; a dramatic or dramatico-musical work; a choreographic work or\n entertainment in dumb show; a musical composition with or without words;\n a cinematographic work to which are assimilated works expressed by a\n process analogous to cinematography; a work of drawing, painting,\n architecture, sculpture, engraving or lithography; a photographic work\n to which are assimilated works expressed by a process analogous to\n photography; a work of applied art; an illustration, map, plan, sketch\n or three-dimensional work relative to geography, topography,\n architecture or science; a performance; a broadcast; a phonogram; a\n compilation of data to the extent it is protected as a copyrightable\n work; or a work performed by a variety or circus performer to the extent\n it is not otherwise considered a literary or artistic work.\n \n i. \"You\" means an individual or entity exercising rights under this License\n who has not previously violated the terms of this License with respect\n to the Work, or who has received express permission from the Licensor to\n exercise rights under this License despite a previous violation.\n \n j. \"Publicly Perform\" means to perform public recitations of the Work and\n to communicate to the public those public recitations, by any means or\n process, including by wire or wireless means or public digital\n performances; to make available to the public Works in such a way that\n members of the public may access these Works from a place and at a place\n individually chosen by them; to perform the Work to the public by any\n means or process and the communication to the public of the performances\n of the Work, including by public digital performance; to broadcast and\n rebroadcast the Work by any means including signs, sounds or images.\n \n k. \"Reproduce\" means to make copies of the Work by any means including\n without limitation by sound or visual recordings and the right of\n fixation and reproducing fixations of the Work, including storage of a\n protected performance or phonogram in digital form or other electronic\n medium.\n \n 2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or\n restrict any uses free from copyright or rights arising from limitations or\n exceptions that are provided for in connection with the copyright protection\n under copyright law or other applicable laws.\n \n 3. License Grant. Subject to the terms and conditions of this License, Licensor\n hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for\n the duration of the applicable copyright) license to exercise the rights in\n the Work as stated below:\n \n a. to Reproduce the Work, to incorporate the Work into one or more\n Collections, and to Reproduce the Work as incorporated in the\n Collections;\n \n b. to create and Reproduce Adaptations provided that any such Adaptation,\n including any translation in any medium, takes reasonable steps to\n clearly label, demarcate or otherwise identify that changes were made to\n the original Work. For example, a translation could be marked \"The\n original work was translated from English to Spanish,\" or a modification\n could indicate \"The original work has been modified.\";\n \n c. to Distribute and Publicly Perform the Work including as incorporated in\n Collections; and,\n \n d. to Distribute and Publicly Perform Adaptations.\n \n e. For the avoidance of doubt:\n \n i. Non-waivable Compulsory License Schemes. In those jurisdictions in\n which the right to collect royalties through any statutory or\n compulsory licensing scheme cannot be waived, the Licensor reserves\n the exclusive right to collect such royalties for any exercise by\n You of the rights granted under this License;\n \n ii. Waivable Compulsory License Schemes. In those jurisdictions in\n which the right to collect royalties through any statutory or\n compulsory licensing scheme can be waived, the Licensor waives the\n exclusive right to collect such royalties for any exercise by You\n of the rights granted under this License; and,\n \n iii. Voluntary License Schemes. The Licensor waives the right to\n collect royalties, whether individually or, in the event that the\n Licensor is a member of a collecting society that administers\n voluntary licensing schemes, via that society, from any exercise\n by You of the rights granted under this License.\n \n The above rights may be exercised in all media and formats whether now known or\n hereafter devised. The above rights include the right to make such modifications\n as are technically necessary to exercise the rights in other media and\n formats. Subject to Section 8(f), all rights not expressly granted by Licensor\n are hereby reserved.\n \n 4. Restrictions. The license granted in Section 3 above is expressly made\n subject to and limited by the following restrictions:\n \n a. You may Distribute or Publicly Perform the Work only under the terms of\n this License. You must include a copy of, or the Uniform Resource\n Identifier (URI) for, this License with every copy of the Work You\n Distribute or Publicly Perform. You may not offer or impose any terms on\n the Work that restrict the terms of this License or the ability of the\n recipient of the Work to exercise the rights granted to that recipient\n under the terms of the License. You may not sublicense the Work. You\n must keep intact all notices that refer to this License and to the\n disclaimer of warranties with every copy of the Work You Distribute or\n Publicly Perform. When You Distribute or Publicly Perform the Work, You\n may not impose any effective technological measures on the Work that\n restrict the ability of a recipient of the Work from You to exercise the\n rights granted to that recipient under the terms of the License. This\n Section 4(a) applies to the Work as incorporated in a Collection, but\n this does not require the Collection apart from the Work itself to be\n made subject to the terms of this License. If You create a Collection,\n upon notice from any Licensor You must, to the extent practicable,\n remove from the Collection any credit as required by Section 4(c), as\n requested. If You create an Adaptation, upon notice from any Licensor\n You must, to the extent practicable, remove from the Adaptation any\n credit as required by Section 4(c), as requested.\n \n b. You may Distribute or Publicly Perform an Adaptation only under the\n terms of: (i) this License; (ii) a later version of this License with\n the same License Elements as this License; (iii) a Creative Commons\n jurisdiction license (either this or a later license version) that\n contains the same License Elements as this License (e.g.,\n Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible\n License. If you license the Adaptation under one of the licenses\n mentioned in (iv), you must comply with the terms of that license. If\n you license the Adaptation under the terms of any of the licenses\n mentioned in (i), (ii) or (iii) (the \"Applicable License\"), you must\n comply with the terms of the Applicable License generally and the\n following provisions: (I) You must include a copy of, or the URI for,\n the Applicable License with every copy of each Adaptation You Distribute\n or Publicly Perform; (II) You may not offer or impose any terms on the\n Adaptation that restrict the terms of the Applicable License or the\n ability of the recipient of the Adaptation to exercise the rights\n granted to that recipient under the terms of the Applicable License;\n (III) You must keep intact all notices that refer to the Applicable\n License and to the disclaimer of warranties with every copy of the Work\n as included in the Adaptation You Distribute or Publicly Perform; (IV)\n when You Distribute or Publicly Perform the Adaptation, You may not\n impose any effective technological measures on the Adaptation that\n restrict the ability of a recipient of the Adaptation from You to\n exercise the rights granted to that recipient under the terms of the\n Applicable License. This Section 4(b) applies to the Adaptation as\n incorporated in a Collection, but this does not require the Collection\n apart from the Adaptation itself to be made subject to the terms of the\n Applicable License.\n \n c. If You Distribute, or Publicly Perform the Work or any Adaptations or\n Collections, You must, unless a request has been made pursuant to\n Section 4(a), keep intact all copyright notices for the Work and\n provide, reasonable to the medium or means You are utilizing: (i) the\n name of the Original Author (or pseudonym, if applicable) if supplied,\n and/or if the Original Author and/or Licensor designate another party or\n parties (e.g., a sponsor institute, publishing entity, journal) for\n attribution (\"Attribution Parties\") in Licensor's copyright notice,\n terms of service or by other reasonable means, the name of such party or\n parties; (ii) the title of the Work if supplied; (iii) to the extent\n reasonably practicable, the URI, if any, that Licensor specifies to be\n associated with the Work, unless such URI does not refer to the\n copyright notice or licensing information for the Work; and (iv) ,\n consistent with Ssection 3(b), in the case of an Adaptation, a credit\n identifying the use of the Work in the Adaptation (e.g., \"French\n translation of the Work by Original Author,\" or \"Screenplay based on\n original Work by Original Author\"). The credit required by this Section\n 4(c) may be implemented in any reasonable manner; provided, however,\n that in the case of a Adaptation or Collection, at a minimum such credit\n will appear, if a credit for all contributing authors of the Adaptation\n or Collection appears, then as part of these credits and in a manner at\n least as prominent as the credits for the other contributing\n authors. For the avoidance of doubt, You may only use the credit\n required by this Section for the purpose of attribution in the manner\n set out above and, by exercising Your rights under this License, You may\n not implicitly or explicitly assert or imply any connection with,\n sponsorship or endorsement by the Original Author, Licensor and/or\n Attribution Parties, as appropriate, of You or Your use of the Work,\n without the separate, express prior written permission of the Original\n Author, Licensor and/or Attribution Parties.\n \n d. Except as otherwise agreed in writing by the Licensor or as may be\n otherwise permitted by applicable law, if You Reproduce, Distribute or\n Publicly Perform the Work either by itself or as part of any Adaptations\n or Collections, You must not distort, mutilate, modify or take other\n derogatory action in relation to the Work which would be prejudicial to\n the Original Author's honor or reputation. Licensor agrees that in those\n jurisdictions (e.g. Japan), in which any exercise of the right granted\n in Section 3(b) of this License (the right to make Adaptations) would be\n deemed to be a distortion, mutilation, modification or other derogatory\n action prejudicial to the Original Author's honor and reputation, the\n Licensor will waive or not assert, as appropriate, this Section, to the\n fullest extent permitted by the applicable national law, to enable You\n to reasonably exercise Your right under Section 3(b) of this License\n (right to make Adaptations) but not otherwise.\n \n 5. Representations, Warranties and Disclaimer\n \n UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS\n THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING\n THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT\n LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR\n PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY,\n OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME\n JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH\n EXCLUSION MAY NOT APPLY TO YOU.\n \n 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN\n NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL,\n INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS\n LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE\n POSSIBILITY OF SUCH DAMAGES.\n \n 7. Termination\n \n a. This License and the rights granted hereunder will terminate\n automatically upon any breach by You of the terms of this\n License. Individuals or entities who have received Adaptations or\n Collections from You under this License, however, will not have their\n licenses terminated provided such individuals or entities remain in full\n compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will\n survive any termination of this License.\n \n b. Subject to the above terms and conditions, the license granted here is\n perpetual (for the duration of the applicable copyright in the\n Work). Notwithstanding the above, Licensor reserves the right to release\n the Work under different license terms or to stop distributing the Work\n at any time; provided, however that any such election will not serve to\n withdraw this License (or any other license that has been, or is\n required to be, granted under the terms of this License), and this\n License will continue in full force and effect unless terminated as\n stated above.\n \n 8. Miscellaneous\n \n a. Each time You Distribute or Publicly Perform the Work or a Collection,\n the Licensor offers to the recipient a license to the Work on the same\n terms and conditions as the license granted to You under this License.\n \n b. Each time You Distribute or Publicly Perform an Adaptation, Licensor\n offers to the recipient a license to the original Work on the same terms\n and conditions as the license granted to You under this License.\n \n c. If any provision of this License is invalid or unenforceable under\n applicable law, it shall not affect the validity or enforceability of\n the remainder of the terms of this License, and without further action\n by the parties to this agreement, such provision shall be reformed to\n the minimum extent necessary to make such provision valid and\n enforceable.\n \n d. No term or provision of this License shall be deemed waived and no\n breach consented to unless such waiver or consent shall be in writing\n and signed by the party to be charged with such waiver or consent.\n \n e. This License constitutes the entire agreement between the parties with\n respect to the Work licensed here. There are no understandings,\n agreements or representations with respect to the Work not specified\n here. Licensor shall not be bound by any additional provisions that may\n appear in any communication from You. This License may not be modified\n without the mutual written agreement of the Licensor and You.\n \n f. The rights granted under, and the subject matter referenced, in this\n License were drafted utilizing the terminology of the Berne Convention\n for the Protection of Literary and Artistic Works (as amended on\n September 28, 1979), the Rome Convention of 1961, the WIPO Copyright\n Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and\n the Universal Copyright Convention (as revised on July 24, 1971). These\n rights and subject matter take effect in the relevant jurisdiction in\n which the License terms are sought to be enforced according to the\n corresponding provisions of the implementation of those treaty\n provisions in the applicable national law. If the standard suite of\n rights granted under applicable copyright law includes additional rights\n not granted under this License, such additional rights are deemed to be\n included in the License; this License is not intended to restrict the\n license of any rights under applicable law.\n \n Creative Commons Notice\n \n Creative Commons is not a party to this License, and makes no warranty\n whatsoever in connection with the Work. Creative Commons will not be liable to\n You or any party on any legal theory for any damages whatsoever, including\n without limitation any general, special, incidental or consequential damages\n arising in connection to this license. Notwithstanding the foregoing two (2)\n sentences, if Creative Commons has expressly identified itself as the Licensor\n hereunder, it shall have all rights and obligations of Licensor.\n \n Except for the limited purpose of indicating to the public that the Work is\n licensed under the CCPL, Creative Commons does not authorize the use by either\n party of the trademark \"Creative Commons\" or any related trademark or logo of\n Creative Commons without the prior written consent of Creative Commons. Any\n permitted use will be in compliance with Creative Commons' then-current\n trademark usage guidelines, as may be published on its website or otherwise made\n available upon request from time to time. For the avoidance of doubt, this\n trademark restriction does not form part of the License.\n \n Creative Commons may be contacted at http://creativecommons.org/.\n \n --------------------------------------------------------------------------------\n \n Files: sphinx_immaterial/cppreference_data/index-functions-{c,cpp}.xml\n \n Copyright (C) 2012 Povilas Kanapickas \n \n Permission is granted to copy, distribute and/or modify this document under the\n terms of the GNU Free Documentation License, Version 1.3 or any later version\n published by the Free Software Foundation; with no Invariant Sections, no\n Front-Cover Texts, and no Back-Cover Texts.\n \n GNU Free Documentation License\n Version 1.3, 3 November 2008\n \n \n Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.\n \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n \n 0. PREAMBLE\n \n The purpose of this License is to make a manual, textbook, or other\n functional and useful document \"free\" in the sense of freedom: to\n assure everyone the effective freedom to copy and redistribute it,\n with or without modifying it, either commercially or noncommercially.\n Secondarily, this License preserves for the author and publisher a way\n to get credit for their work, while not being considered responsible\n for modifications made by others.\n \n This License is a kind of \"copyleft\", which means that derivative\n works of the document must themselves be free in the same sense. It\n complements the GNU General Public License, which is a copyleft\n license designed for free software.\n \n We have designed this License in order to use it for manuals for free\n software, because free software needs free documentation: a free\n program should come with manuals providing the same freedoms that the\n software does. But this License is not limited to software manuals;\n it can be used for any textual work, regardless of subject matter or\n whether it is published as a printed book. We recommend this License\n principally for works whose purpose is instruction or reference.\n \n \n 1. APPLICABILITY AND DEFINITIONS\n \n This License applies to any manual or other work, in any medium, that\n contains a notice placed by the copyright holder saying it can be\n distributed under the terms of this License. Such a notice grants a\n world-wide, royalty-free license, unlimited in duration, to use that\n work under the conditions stated herein. The \"Document\", below,\n refers to any such manual or work. Any member of the public is a\n licensee, and is addressed as \"you\". You accept the license if you\n copy, modify or distribute the work in a way requiring permission\n under copyright law.\n \n A \"Modified Version\" of the Document means any work containing the\n Document or a portion of it, either copied verbatim, or with\n modifications and/or translated into another language.\n \n A \"Secondary Section\" is a named appendix or a front-matter section of\n the Document that deals exclusively with the relationship of the\n publishers or authors of the Document to the Document's overall\n subject (or to related matters) and contains nothing that could fall\n directly within that overall subject. (Thus, if the Document is in\n part a textbook of mathematics, a Secondary Section may not explain\n any mathematics.) The relationship could be a matter of historical\n connection with the subject or with related matters, or of legal,\n commercial, philosophical, ethical or political position regarding\n them.\n \n The \"Invariant Sections\" are certain Secondary Sections whose titles\n are designated, as being those of Invariant Sections, in the notice\n that says that the Document is released under this License. If a\n section does not fit the above definition of Secondary then it is not\n allowed to be designated as Invariant. The Document may contain zero\n Invariant Sections. If the Document does not identify any Invariant\n Sections then there are none.\n \n The \"Cover Texts\" are certain short passages of text that are listed,\n as Front-Cover Texts or Back-Cover Texts, in the notice that says that\n the Document is released under this License. A Front-Cover Text may\n be at most 5 words, and a Back-Cover Text may be at most 25 words.\n \n A \"Transparent\" copy of the Document means a machine-readable copy,\n represented in a format whose specification is available to the\n general public, that is suitable for revising the document\n straightforwardly with generic text editors or (for images composed of\n pixels) generic paint programs or (for drawings) some widely available\n drawing editor, and that is suitable for input to text formatters or\n for automatic translation to a variety of formats suitable for input\n to text formatters. A copy made in an otherwise Transparent file\n format whose markup, or absence of markup, has been arranged to thwart\n or discourage subsequent modification by readers is not Transparent.\n An image format is not Transparent if used for any substantial amount\n of text. A copy that is not \"Transparent\" is called \"Opaque\".\n \n Examples of suitable formats for Transparent copies include plain\n ASCII without markup, Texinfo input format, LaTeX input format, SGML\n or XML using a publicly available DTD, and standard-conforming simple\n HTML, PostScript or PDF designed for human modification. Examples of\n transparent image formats include PNG, XCF and JPG. Opaque formats\n include proprietary formats that can be read and edited only by\n proprietary word processors, SGML or XML for which the DTD and/or\n processing tools are not generally available, and the\n machine-generated HTML, PostScript or PDF produced by some word\n processors for output purposes only.\n \n The \"Title Page\" means, for a printed book, the title page itself,\n plus such following pages as are needed to hold, legibly, the material\n this License requires to appear in the title page. For works in\n formats which do not have any title page as such, \"Title Page\" means\n the text near the most prominent appearance of the work's title,\n preceding the beginning of the body of the text.\n \n The \"publisher\" means any person or entity that distributes copies of\n the Document to the public.\n \n A section \"Entitled XYZ\" means a named subunit of the Document whose\n title either is precisely XYZ or contains XYZ in parentheses following\n text that translates XYZ in another language. (Here XYZ stands for a\n specific section name mentioned below, such as \"Acknowledgements\",\n \"Dedications\", \"Endorsements\", or \"History\".) To \"Preserve the Title\"\n of such a section when you modify the Document means that it remains a\n section \"Entitled XYZ\" according to this definition.\n \n The Document may include Warranty Disclaimers next to the notice which\n states that this License applies to the Document. These Warranty\n Disclaimers are considered to be included by reference in this\n License, but only as regards disclaiming warranties: any other\n implication that these Warranty Disclaimers may have is void and has\n no effect on the meaning of this License.\n \n 2. VERBATIM COPYING\n \n You may copy and distribute the Document in any medium, either\n commercially or noncommercially, provided that this License, the\n copyright notices, and the license notice saying this License applies\n to the Document are reproduced in all copies, and that you add no\n other conditions whatsoever to those of this License. You may not use\n technical measures to obstruct or control the reading or further\n copying of the copies you make or distribute. However, you may accept\n compensation in exchange for copies. If you distribute a large enough\n number of copies you must also follow the conditions in section 3.\n \n You may also lend copies, under the same conditions stated above, and\n you may publicly display copies.\n \n \n 3. COPYING IN QUANTITY\n \n If you publish printed copies (or copies in media that commonly have\n printed covers) of the Document, numbering more than 100, and the\n Document's license notice requires Cover Texts, you must enclose the\n copies in covers that carry, clearly and legibly, all these Cover\n Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on\n the back cover. Both covers must also clearly and legibly identify\n you as the publisher of these copies. The front cover must present\n the full title with all words of the title equally prominent and\n visible. You may add other material on the covers in addition.\n Copying with changes limited to the covers, as long as they preserve\n the title of the Document and satisfy these conditions, can be treated\n as verbatim copying in other respects.\n \n If the required texts for either cover are too voluminous to fit\n legibly, you should put the first ones listed (as many as fit\n reasonably) on the actual cover, and continue the rest onto adjacent\n pages.\n \n If you publish or distribute Opaque copies of the Document numbering\n more than 100, you must either include a machine-readable Transparent\n copy along with each Opaque copy, or state in or with each Opaque copy\n a computer-network location from which the general network-using\n public has access to download using public-standard network protocols\n a complete Transparent copy of the Document, free of added material.\n If you use the latter option, you must take reasonably prudent steps,\n when you begin distribution of Opaque copies in quantity, to ensure\n that this Transparent copy will remain thus accessible at the stated\n location until at least one year after the last time you distribute an\n Opaque copy (directly or through your agents or retailers) of that\n edition to the public.\n \n It is requested, but not required, that you contact the authors of the\n Document well before redistributing any large number of copies, to\n give them a chance to provide you with an updated version of the\n Document.\n \n \n 4. MODIFICATIONS\n \n You may copy and distribute a Modified Version of the Document under\n the conditions of sections 2 and 3 above, provided that you release\n the Modified Version under precisely this License, with the Modified\n Version filling the role of the Document, thus licensing distribution\n and modification of the Modified Version to whoever possesses a copy\n of it. In addition, you must do these things in the Modified Version:\n \n A. Use in the Title Page (and on the covers, if any) a title distinct\n from that of the Document, and from those of previous versions\n (which should, if there were any, be listed in the History section\n of the Document). You may use the same title as a previous version\n if the original publisher of that version gives permission.\n B. List on the Title Page, as authors, one or more persons or entities\n responsible for authorship of the modifications in the Modified\n Version, together with at least five of the principal authors of the\n Document (all of its principal authors, if it has fewer than five),\n unless they release you from this requirement.\n C. State on the Title page the name of the publisher of the\n Modified Version, as the publisher.\n D. Preserve all the copyright notices of the Document.\n E. Add an appropriate copyright notice for your modifications\n adjacent to the other copyright notices.\n F. Include, immediately after the copyright notices, a license notice\n giving the public permission to use the Modified Version under the\n terms of this License, in the form shown in the Addendum below.\n G. Preserve in that license notice the full lists of Invariant Sections\n and required Cover Texts given in the Document's license notice.\n H. Include an unaltered copy of this License.\n I. Preserve the section Entitled \"History\", Preserve its Title, and add\n to it an item stating at least the title, year, new authors, and\n publisher of the Modified Version as given on the Title Page. If\n there is no section Entitled \"History\" in the Document, create one\n stating the title, year, authors, and publisher of the Document as\n given on its Title Page, then add an item describing the Modified\n Version as stated in the previous sentence.\n J. Preserve the network location, if any, given in the Document for\n public access to a Transparent copy of the Document, and likewise\n the network locations given in the Document for previous versions\n it was based on. These may be placed in the \"History\" section.\n You may omit a network location for a work that was published at\n least four years before the Document itself, or if the original\n publisher of the version it refers to gives permission.\n K. For any section Entitled \"Acknowledgements\" or \"Dedications\",\n Preserve the Title of the section, and preserve in the section all\n the substance and tone of each of the contributor acknowledgements\n and/or dedications given therein.\n L. Preserve all the Invariant Sections of the Document,\n unaltered in their text and in their titles. Section numbers\n or the equivalent are not considered part of the section titles.\n M. Delete any section Entitled \"Endorsements\". Such a section\n may not be included in the Modified Version.\n N. Do not retitle any existing section to be Entitled \"Endorsements\"\n or to conflict in title with any Invariant Section.\n O. Preserve any Warranty Disclaimers.\n \n If the Modified Version includes new front-matter sections or\n appendices that qualify as Secondary Sections and contain no material\n copied from the Document, you may at your option designate some or all\n of these sections as invariant. To do this, add their titles to the\n list of Invariant Sections in the Modified Version's license notice.\n These titles must be distinct from any other section titles.\n \n You may add a section Entitled \"Endorsements\", provided it contains\n nothing but endorsements of your Modified Version by various\n parties--for example, statements of peer review or that the text has\n been approved by an organization as the authoritative definition of a\n standard.\n \n You may add a passage of up to five words as a Front-Cover Text, and a\n passage of up to 25 words as a Back-Cover Text, to the end of the list\n of Cover Texts in the Modified Version. Only one passage of\n Front-Cover Text and one of Back-Cover Text may be added by (or\n through arrangements made by) any one entity. If the Document already\n includes a cover text for the same cover, previously added by you or\n by arrangement made by the same entity you are acting on behalf of,\n you may not add another; but you may replace the old one, on explicit\n permission from the previous publisher that added the old one.\n \n The author(s) and publisher(s) of the Document do not by this License\n give permission to use their names for publicity for or to assert or\n imply endorsement of any Modified Version.\n \n \n 5. COMBINING DOCUMENTS\n \n You may combine the Document with other documents released under this\n License, under the terms defined in section 4 above for modified\n versions, provided that you include in the combination all of the\n Invariant Sections of all of the original documents, unmodified, and\n list them all as Invariant Sections of your combined work in its\n license notice, and that you preserve all their Warranty Disclaimers.\n \n The combined work need only contain one copy of this License, and\n multiple identical Invariant Sections may be replaced with a single\n copy. If there are multiple Invariant Sections with the same name but\n different contents, make the title of each such section unique by\n adding at the end of it, in parentheses, the name of the original\n author or publisher of that section if known, or else a unique number.\n Make the same adjustment to the section titles in the list of\n Invariant Sections in the license notice of the combined work.\n \n In the combination, you must combine any sections Entitled \"History\"\n in the various original documents, forming one section Entitled\n \"History\"; likewise combine any sections Entitled \"Acknowledgements\",\n and any sections Entitled \"Dedications\". You must delete all sections\n Entitled \"Endorsements\".\n \n \n 6. COLLECTIONS OF DOCUMENTS\n \n You may make a collection consisting of the Document and other\n documents released under this License, and replace the individual\n copies of this License in the various documents with a single copy\n that is included in the collection, provided that you follow the rules\n of this License for verbatim copying of each of the documents in all\n other respects.\n \n You may extract a single document from such a collection, and\n distribute it individually under this License, provided you insert a\n copy of this License into the extracted document, and follow this\n License in all other respects regarding verbatim copying of that\n document.\n \n \n 7. AGGREGATION WITH INDEPENDENT WORKS\n \n A compilation of the Document or its derivatives with other separate\n and independent documents or works, in or on a volume of a storage or\n distribution medium, is called an \"aggregate\" if the copyright\n resulting from the compilation is not used to limit the legal rights\n of the compilation's users beyond what the individual works permit.\n When the Document is included in an aggregate, this License does not\n apply to the other works in the aggregate which are not themselves\n derivative works of the Document.\n \n If the Cover Text requirement of section 3 is applicable to these\n copies of the Document, then if the Document is less than one half of\n the entire aggregate, the Document's Cover Texts may be placed on\n covers that bracket the Document within the aggregate, or the\n electronic equivalent of covers if the Document is in electronic form.\n Otherwise they must appear on printed covers that bracket the whole\n aggregate.\n \n \n 8. TRANSLATION\n \n Translation is considered a kind of modification, so you may\n distribute translations of the Document under the terms of section 4.\n Replacing Invariant Sections with translations requires special\n permission from their copyright holders, but you may include\n translations of some or all Invariant Sections in addition to the\n original versions of these Invariant Sections. You may include a\n translation of this License, and all the license notices in the\n Document, and any Warranty Disclaimers, provided that you also include\n the original English version of this License and the original versions\n of those notices and disclaimers. In case of a disagreement between\n the translation and the original version of this License or a notice\n or disclaimer, the original version will prevail.\n \n If a section in the Document is Entitled \"Acknowledgements\",\n \"Dedications\", or \"History\", the requirement (section 4) to Preserve\n its Title (section 1) will typically require changing the actual\n title.\n \n \n 9. TERMINATION\n \n You may not copy, modify, sublicense, or distribute the Document\n except as expressly provided under this License. Any attempt\n otherwise to copy, modify, sublicense, or distribute it is void, and\n will automatically terminate your rights under this License.\n \n However, if you cease all violation of this License, then your license\n from a particular copyright holder is reinstated (a) provisionally,\n unless and until the copyright holder explicitly and finally\n terminates your license, and (b) permanently, if the copyright holder\n fails to notify you of the violation by some reasonable means prior to\n 60 days after the cessation.\n \n Moreover, your license from a particular copyright holder is\n reinstated permanently if the copyright holder notifies you of the\n violation by some reasonable means, this is the first time you have\n received notice of violation of this License (for any work) from that\n copyright holder, and you cure the violation prior to 30 days after\n your receipt of the notice.\n \n Termination of your rights under this section does not terminate the\n licenses of parties who have received copies or rights from you under\n this License. If your rights have been terminated and not permanently\n reinstated, receipt of a copy of some or all of the same material does\n not give you any rights to use it.\n \n \n 10. FUTURE REVISIONS OF THIS LICENSE\n \n The Free Software Foundation may publish new, revised versions of the\n GNU Free Documentation License from time to time. Such new versions\n will be similar in spirit to the present version, but may differ in\n detail to address new problems or concerns. See\n https://www.gnu.org/licenses/.\n \n Each version of the License is given a distinguishing version number.\n If the Document specifies that a particular numbered version of this\n License \"or any later version\" applies to it, you have the option of\n following the terms and conditions either of that specified version or\n of any later version that has been published (not as a draft) by the\n Free Software Foundation. If the Document does not specify a version\n number of this License, you may choose any version ever published (not\n as a draft) by the Free Software Foundation. If the Document\n specifies that a proxy can decide which future versions of this\n License can be used, that proxy's public statement of acceptance of a\n version permanently authorizes you to choose that version for the\n Document.\n \n 11. RELICENSING\n \n \"Massive Multiauthor Collaboration Site\" (or \"MMC Site\") means any\n World Wide Web server that publishes copyrightable works and also\n provides prominent facilities for anybody to edit those works. A\n public wiki that anybody can edit is an example of such a server. A\n \"Massive Multiauthor Collaboration\" (or \"MMC\") contained in the site\n means any set of copyrightable works thus published on the MMC site.\n \n \"CC-BY-SA\" means the Creative Commons Attribution-Share Alike 3.0\n license published by Creative Commons Corporation, a not-for-profit\n corporation with a principal place of business in San Francisco,\n California, as well as future copyleft versions of that license\n published by that same organization.\n \n \"Incorporate\" means to publish or republish a Document, in whole or in\n part, as part of another Document.\n \n An MMC is \"eligible for relicensing\" if it is licensed under this\n License, and if all works that were first published under this License\n somewhere other than this MMC, and subsequently incorporated in whole or\n in part into the MMC, (1) had no cover texts or invariant sections, and\n (2) were thus incorporated prior to November 1, 2008.\n \n The operator of an MMC Site may republish an MMC contained in the site\n under CC-BY-SA on the same site at any time before August 1, 2009,\n provided the MMC is eligible for relicensing.\n \n \n ADDENDUM: How to use this License for your documents\n \n To use this License in a document you have written, include a copy of\n the License in the document and put the following copyright and\n license notices just after the title page:\n \n Copyright (c) YEAR YOUR NAME.\n Permission is granted to copy, distribute and/or modify this document\n under the terms of the GNU Free Documentation License, Version 1.3\n or any later version published by the Free Software Foundation;\n with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.\n A copy of the license is included in the section entitled \"GNU\n Free Documentation License\".\n \n If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,\n replace the \"with...Texts.\" line with this:\n \n with the Invariant Sections being LIST THEIR TITLES, with the\n Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.\n \n If you have Invariant Sections without Cover Texts, or some other\n combination of the three, merge those two alternatives to suit the\n situation.\n \n If your document contains nontrivial examples of program code, we\n recommend releasing these examples in parallel under your choice of\n free software license, such as the GNU General Public License,\n to permit their use in free software.\n ","license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"sphinx-immaterial","package_url":"https://pypi.org/project/sphinx-immaterial/","platform":null,"project_url":"https://pypi.org/project/sphinx-immaterial/","project_urls":{"Documentation":"https://jbms.github.io/sphinx-immaterial","Issues":"https://github.com/jbms/sphinx-immaterial/issues","Repository":"https://github.com/jbms/sphinx-immaterial"},"provides_extra":["json","clang-format","black","cpp","jsonschema-validation","keys"],"release_url":"https://pypi.org/project/sphinx-immaterial/0.13.5/","requires_dist":["sphinx>=6","markupsafe","pydantic>=2.4","pydantic-extra-types","typing-extensions","appdirs","requests","pyyaml; extra == \"json\"","clang-format; extra == \"clang-format\"","black; extra == \"black\"","libclang; extra == \"cpp\"","jsonschema; extra == \"jsonschema-validation\"","pymdown-extensions; extra == \"keys\""],"requires_python":">=3.10","summary":"Adaptation of mkdocs-material theme for the Sphinx documentation system","version":"0.13.5","yanked":false,"yanked_reason":null}

Dependency	Optional
appdirs	false
markupsafe	false
pydantic	false
pydantic-extra-types	false
requests	false
sphinx	false
typing-extensions	false
black	true
clang-format	true
jsonschema	true
libclang	true
pymdown-extensions	true
pyyaml	true

Package search

sphinx-immaterial

project_urls

Dependencies

All package metadata

Releases