.. toctree::
:hidden:
:maxdepth: 1
:caption: Main
:name: main-nav
preview
conf
.. toctree::
:hidden:
:maxdepth: 1
:caption: Custom Files
:name: sec-files
/otherpages/singlepage
/otherpages/test.single
/otherpages/test.right
/otherpages/rightpage
Fandango
=========
.. note::
This theme is part of the `themata `_ collection.
Setting up and using the fandango theme.
Install the themata package from python index.
.. code:: bash
pip install themata
or equivalent (add `themata` to any appropriate requirements files).
Example
---------
Below is a minimal sample **conf.py** file to use the fandango theme.
.. code:: python
import os
import themata
project = 'Fandango Doc'
copyright = '2020, Adewale Azeez'
author = 'Adewale Azeez'
html_favicon = 'favicon.png'
html_theme = 'fandango'
html_theme_optionss = {
'project_icon': 'favicon.png'
}
Theme Options
--------------
The following theme options are accepted in the theme.
Variable Options
'''''''''''''''''
.. csv-table::
:header: "Option ", "Description"
"project_icon ", "The abolute or relative (to _static folder) path to the image to use as the theme icon. This is not the same as favicon. If the favicon is set using the variable `html_favicon` and the project_icon is not set. The project_icon value will be the value of the favicon."
"index_is_single ", "This option is to indicate if any **index** page does not have sidebars. It is True by default which means any index page will not have any sidebar. To add sidebars to index pages set the value to False in `html_theme_optionss`."
"show_navigators_in_index ", "The theme option to decide whether to show the bottom navigation buttons (index, next, previous) in any **index** page. By default it is False. To show the navigation buttons in index pages set the value to True in the `html_theme_optionss`."
"has_secondary_header ", "The theme option to decide whether to show the secondary header. By default it is False. To show the secondary header set the value to True in the `html_theme_optionss`."
"navbar_links ", "The navbar menus to show at the header of the page, each of the entry should be a tupple of the name and the link e.g for a menu that link to twitter and github.
.. code:: python
html_theme_options = {
'navbar_links': [
('Twitter', 'https://twitter.com/iamthecarisma'),
('Github', 'https://github.com/Thecarisma/themata/')
]
}
"
"has_right_sidebar ", "By default this theme renders the right sidebar. The left sidebar shows the table of content for the active page, the previous and next topic and the link to the page source. To not shouw the right sidebar in all the pages set the value to False in the `html_theme_options`."
"footer_menus ", "The footer menu to show at the bottom of the page, each of the footer should contain the 'title' and the array of the 'menu_items'.
.. code:: python
html_theme_options = {
'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 ", "The social icons to show at the foot of the page, each of the social link should be a tupple of the favicon icon and the link e.g for a social icon of twitter and github.
.. code:: python
html_theme_options = {
'social_icons': [
('fab fa-twitter', 'https://twitter.com/iamthecarisma'),
('fab fa-github', 'https://github.com/Thecarisma/themata/')
]
}
"
"show_navigators ", "Theme option to decide whether to show the bottom navigation buttons (index, previous and next) at the bottom of each of the generated pages. The default is True which means the navigators is shown. To hide the navigation set the value of show_navigators to False in `html_theme_options`."
"right_sidebar_only ", "An array list of pages name to have only the right sidebar. Any pagename added to this array will have ONLY the right sidebar regardless of other sidebar options. E.g.
.. code:: python
html_theme_options = {
'right_sidebar_only': [
'otherpages/rightpage'
]
}
The name of the page must be relative to the index project root folder. Another way to make a page have only the right sidebar is to add the extension **.right** to it file name e.g. **test.right.rst**"
"no_sidebar ", "An array list of pages name to have no sidebar. Any pagename added to this array will have no sidebar regardless of other sidebar options. E.g.
.. code:: python
html_theme_options = {
'no_sidebar': [
'otherpages/singlepage'
]
}
The name of the page must be relative to the index project root folder. Another way to make a page have no sidebar is to add the extension **.single** to it file name e.g. **test.single.rst**"
"secondary_header_link ", "A tupple with the text at index 0 and the link at index 1. The text is shown in the secondary header above the searhc box. e.g.
.. code:: python
html_theme_options = {
'secondary_header_link': ('Support Devcareer', 'https://www.patreon.com/devcareer')
}
"
"toc_title ", "The title of the main toc of the documentation the default is 'Browse'"
"exclude_secondary_header_in ", "The list of pages to not show the secondary header
.. code:: python
html_theme_options = {
'exclude_secondary_header_in': [
'index',
'singlepage'
]
}
"
"source_root ", "The full link to the web root folder where the source of the documentation source is e.g. the documentation github repo"
"source_root_edit_text ", "The text to show on the button that link to the page source in a repository. The default is '**Edit this page**'"
"metadata