Sample Configuration
=====================

The **conf.py** file that generates this documentation.

.. code:: python

    import os
    import themata

    project = 'Clear'
    copyright = '2020, Adewale Azeez, Creative Commons Zero v1.0 Universal License'
    author = 'Adewale Azeez'

    html_theme = 'clear'
    html_favicon = '../images/themata.png'

    html_theme_options = {
        'index_is_single': False,
        'show_navigators_in_index': False,
        'has_left_sidebar': True,
        'has_right_sidebar': True,
        'collapsible_sidebar': True,
        'collapsible_sidebar_display': 'block',
        'syntax_highlighter': 'syntaxy',
        'code_block_editable': False,
        'syntax_highlighter_theme': 'light',
        'syntax_highlighter_iframe_embed': False,
        'show_navigators': True,
        'social_icons': [
            ('fab fa-twitter', 'https://twitter.com/iamthecarisma'),
            ('fab fa-github', 'https://github.com/Thecarisma/themata/')
        ],
        'left_sidebar_only': [
            'otherpages/leftpage'
        ],
        'no_sidebar': [
            'otherpages/singlepage'
        ],
        'right_sidebar_only': [
            'otherpages/rightpage'
        ],
        'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/clear/',
        'source_root_edit_text': 'Edit on Github',
        'metadata': {
            "dynamic": True,
            "url": "https://thecarisma.github.io/themata",
            "type": "website",
            "title": "Set of Highly customizable sphinx themes.",
            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
            "image": "https://raw.githubusercontent.com/Thecarisma/themata/main/docs/images/themata.small.png",
            "keywords": "python, sphinx, thecarisma, themata, documentation, markdown, rst, themes",
            "author": "Adewale Azeez"
        },
        'twitter_metadata': {
            "dynamic": True,
            "card": "summary",
            "site": "@iamthecarisma",
            "creator": "@iamthecarisma",
            "title": "Set of Highly customizable sphinx themes.",
            "description": "Themata package contains different sphinx theme that can be easily customized to look like a complete website or just a documentation webpage.",
            "image": "https://raw.githubusercontent.com/Thecarisma/themata/main/docs/images/themata.small.png",
        }
    }