Hackish

Twitter Github

Page Contents

• Sample Configuration

Other Topics

Main

• Basic Specification
• Sample Configuration

Custom Files

• No Sidebar. Theme Option
• No Sidebar. File Name
• Left Sidebar Only. File Name
• Left Sidebar Only. Theme Option

Previous topic

Basic Specification

Next topic

No Sidebar. Theme Option

This Page

Show source
Edit on Github

Sample Configuration

The conf.py file that generates this documentation.

import os
import themata

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

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

html_theme_options = {
    'index_is_single': False,
    'show_navigators_in_index': False,
    'navbar_links': [
        ('Twitter', 'https://twitter.com/iamthecarisma'),
        ('Github', 'https://github.com/Thecarisma/themata/'),
        ("Introduction", "general/introduction"),
        ("FAQ", "general/faq")
    ],
    'has_left_sidebar': True,
    'show_navigators': True,
    'syntax_highlighter': 'ace',
    'code_block_editable': True,
    'syntax_highlighter_theme': 'monokai',
    'syntax_highlighter_iframe_embed': False,
    'footer_menus': [
        {
            'title': 'Contact',
            'menu_items': [
                {
                    'link': 'https://thecarisma.github.io/',
                    'title': 'https://thecarisma.github.io/'
                },
                {
                    'link': 'tel:911',
                    'title': '12345678998'
                }
            ]
        },
        {
            'title': 'Custom Pages',
            'menu_items': [
                {
                    'link': 'leftpage.html',
                    'title': 'Left Page'
                },
                {
                    'link': 'singletpage.html',
                    'title': 'Single Page'
                }
            ]
        }
    ],
    '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'
    ],
    'toc_title': 'Other Topics',
    'source_root': 'https://github.com/Thecarisma/themata/edit/test/docs/hackish/',
    '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",
    }
}

---

Basic Specification No Sidebar. Theme Option

---

Throw this page at people faces:

Did you find this documentation helpful?

Throw tantrum about this page to the developers

This Project This Page

Look at your like tantrums on github

Submit

---