https://github.com/fossasia/sphinx_fossasia_theme

Theme for Sphinx/Yaydoc
https://github.com/fossasia/sphinx_fossasia_theme

Last synced: 24 days ago
JSON representation

Theme for Sphinx/Yaydoc

• Host: GitHub
• URL: https://github.com/fossasia/sphinx_fossasia_theme
• Owner: fossasia
• License: gpl-3.0
• Created: 2017-07-06T10:27:22.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-27T11:18:32.000Z (about 4 years ago)
• Last Synced: 2025-05-09T23:05:40.565Z (30 days ago)
• Language: HTML
• Homepage:
• Size: 25.4 KB
• Stars: 1,467
• Watchers: 7
• Forks: 13
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
sphinx_fossasia_theme

=====================

.. image:: https://travis-ci.org/fossasia/sphinx_fossasia_theme.svg?branch=master

    :target: https://travis-ci.org/fossasia/sphinx_fossasia_theme

Official bootstrap based Sphinx theme for FOSSASIA

Installation

------------

Download the package or add it to your `requirements.txt`

::

    pip install sphinx_fossasia_theme

In your conf.py file:

::

    html_theme = "sphinx_fossasia_theme"

Configuration

-------------

You can define the theme's project-wide configuration via `html_theme_options`. For example

.. code:: python

   html_theme_options = {

       'show_fossasia_logo': 'true',

       'link_about': '/about',

   }

Following is a list of all available options:

- *link_about*

- *link_docs*

- *link_blog*

- *link_donate*

- *link_contact*

- *link_twitter*

- *link_facebook*

- *show_fossasia_logo*