https://github.com/iktakahiro/sphinx_theme_pd

https://github.com/iktakahiro/sphinx_theme_pd

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/iktakahiro/sphinx_theme_pd
• Owner: iktakahiro
• License: mit
• Created: 2015-02-13T05:43:53.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-28T17:07:40.000Z (about 7 years ago)
• Last Synced: 2024-09-15T11:30:29.684Z (about 2 months ago)
• Language: CSS
• Size: 1.22 MB
• Stars: 20
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Sphinx Theme 'pd'

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

Material Design theme for `Sphinx`_

Sample

------

* https://sphinx-theme-pd.netlify.com/

Screen shot

-----------

.. image:: ./img/sphinx_theme_pd_1.png

.. image:: ./img/sphinx_theme_pd_2.png

.. image:: ./img/sphinx_theme_pd_3.png

.. image:: ./img/sphinx_theme_pd_4.png

Installation

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

1. pip install

.. code::

   $ pip install sphinx_theme_pd

2. Edit your conf.py

.. code::

   import sphinx_theme_pd

   html_theme = "sphinx_theme_pd"

   html_theme_path = [sphinx_theme_pd.get_html_theme_path()]

Build

-----

.. code::

   $ yarn

   $ webpack

.. _Sphinx: http://sphinx-doc.org