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

Sphinx-Immaterial Theme
=======================

|MIT License| |PyPI Package| |CI status| |codecov-badge|

This theme is an adaptation of the popular `mkdocs-material
<https://github.com/squidfunk/mkdocs-material/>`__ theme for the `Sphinx
<https://www.sphinx-doc.org/>`__ documentation tool.

This theme is regularly maintained to stay up to date with the upstream
`mkdocs-material <https://squidfunk.github.io/mkdocs-material/>`__ repository.
The HTML templates, JavaScript, and styles from the `mkdocs-material
<https://squidfunk.github.io/mkdocs-material/>`__ theme are incoroprated directly
with mostly minor modifications.

This theme is a fork of the `sphinx-material
<https://github.com/bashtage/sphinx-material>`__ theme, which proved the concept
of a Sphinx theme based on an earlier version of the `mkdocs-material
<https://squidfunk.github.io/mkdocs-material/>`__ theme, but has now
significantly diverged from the upstream `mkdocs-material
<https://squidfunk.github.io/mkdocs-material/>`__ repository.

See `this theme's own documentation
<https://jbms.github.io/sphinx-immaterial/>`__ for a demonstration.

WARNING: This theme is still in beta.  While it is already very usable, breaking
changes will still be made prior to the 1.0 release.

Installation
------------

Install via pip:

.. code-block:: bash

    $ pip install sphinx-immaterial

or if you have the code checked out locally:

.. code-block:: bash

    $ pip install -e .

Configuration
-------------

In your `conf.py` add `sphinx_immaterial` as an extension:

.. code-block:: python

    extensions = [
        ...,
        "sphinx_immaterial"
    ]

and add the following:

.. code-block:: python

    html_theme = 'sphinx_immaterial'

to set the theme.

Customizing the layout
----------------------

You can customize the theme by overriding Jinja template blocks. For example,
'layout.html' contains several blocks that can be overridden or extended.

Place a 'layout.html' file in your project's '/_templates' directory.

.. code-block:: bash

    mkdir source/_templates
    touch source/_templates/layout.html

Then, configure your 'conf.py':

.. code-block:: python

    templates_path = ['_templates']

Finally, edit your override file 'source/_templates/layout.html':

::

    {# Import the theme's layout. #}
    {% extends '!layout.html' %}

    {%- block extrahead %}
    {# Add custom things to the head HTML tag #}
    {# Call the parent block #}
    {{ super() }}
    {%- endblock %}

Differences from mkdocs-material
--------------------------------

This theme closely follows the upstream `mkdocs-material
<https://github.com/squidfunk/mkdocs-material/>`__ repository, but there are a
few differences, primarily due to differences between Sphinx and MkDocs:

- This theme adds styles for Sphinx object descriptions, commonly used for API
  documentation (e.g. class and function documentation).  This is a core element
  of Sphinx for which there is no corresponding feature in MkDocs.

- mkdocs-material uses `lunr.js <https://lunrjs.com/>`__ for searching, and has
  custom UI components for displaying search results in a drop-down menu as you
  type the search query.  This theme uses a separate search implementation based
  on the custom index format used by Sphinx, which fully integrates with the
  search UI provided by mkdocs-material.

.. |MIT License| image:: https://img.shields.io/badge/License-MIT-blue.svg
   :target: https://opensource.org/licenses/MIT-Clause

.. |PyPI Package| image:: https://img.shields.io/pypi/v/sphinx-immaterial
   :target: https://pypi.org/project/sphinx-immaterial

.. |CI status| image:: https://github.com/jbms/sphinx-immaterial/actions/workflows/build.yml/badge.svg
   :target: https://github.com/jbms/sphinx-immaterial/actions/workflows/build.yml

.. |codecov-badge| image:: https://codecov.io/gh/jbms/sphinx-immaterial/graph/badge.svg?token=IGK0B3WN42
   :alt: codecov
   :target: https://codecov.io/gh/jbms/sphinx-immaterial
