Skip to content

Commit

Permalink
Merge branch 'release/0.8.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
iktakahiro committed Aug 28, 2017
2 parents f50bb3f + ff967b4 commit eb55eb3
Show file tree
Hide file tree
Showing 60 changed files with 18,106 additions and 538 deletions.
9 changes: 7 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
node_modules/
sample/Makefile
sample/make.bat

# IntelliJ IDEA
.idea/*

Expand All @@ -11,9 +15,10 @@ __pycache__/
# Distribution / packaging
.Python
env/
build/
/build/
/dist/
develop-eggs/
dist/
sample/html/
downloads/
eggs/
lib/
Expand Down
25 changes: 22 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,40 @@ Sphinx Theme 'pd'

Material Design theme for `Sphinx`_

Screen shot
-----------

.. image:: ../img/spinx_theme_pd_1.png

.. image:: ../img/spinx_theme_pd_2.png

.. image:: ../img/spinx_theme_pd_3.png

.. image:: ../img/spinx_theme_pd_4.png


Installation
------------

First, pip install.
1. pip install

.. code::
pip install sphinx_theme_pd
$ pip install sphinx_theme_pd
Second, edit your conf.py file.
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "sphinx_theme_pd",
"version": "0.8.0",
"main": "src/ts/pd.ts",
"repository": "https://iktakahiro@github.com/iktakahiro/sphinx_theme_pd.git",
"author": "iktakahiro <takahiro.ikeuchi@gmail.com>",
"license": "MIT",
"devDependencies": {
"@types/jquery": "^3.2.12",
"css-loader": "^0.28.5",
"extract-text-webpack-plugin": "^3.0.0",
"node-sass": "^4.5.3",
"sass-loader": "^6.0.6",
"style-loader": "^0.18.2",
"ts-loader": "^2.3.4",
"typescript": "^2.4.2",
"webpack": "^3.5.5"
},
"dependencies": {
"jquery": "^3.2.1"
}
}
Binary file added sample/build/doctrees/environment.pickle
Binary file not shown.
Binary file added sample/build/doctrees/index.doctree
Binary file not shown.
4 changes: 4 additions & 0 deletions sample/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 248e4578c50b55c0e01478a7b71eec8a
tags: 645f666f9bcd5a90fca523b33c5a78b7
111 changes: 111 additions & 0 deletions sample/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
.. sphinx_theme_pd documentation master file, created by
sphinx-quickstart on Mon Aug 28 15:42:18 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to sphinx_theme_pd's documentation!
===========================================

.. toctree::
:maxdepth: 2
:caption: Contents:

Headings
--------

Heading 2
---------

Heading 3
^^^^^^^^^

Heading 4
+++++++++

Inline Markups
--------------

*emphasis*

**strong emphasis**

``code samples``

Table
-----

List
----

#. One
#. Two
#. Three

Source Code
-----------

.. py:function:: my_function(param1, param2)
The description of my_function.

:param str param1: The description of param1
:param int param2: The description of param2

.. py:class:: MyClass
The description of MyClass.

.. py:method:: my_class_method(param1, param2)
The description of my_class_method.

:param str param1: The description of param1
:param int param2: The description of param2

.. py:staticmethod:: my_static_method(param1, param2)
The description of my_static_method.

:param str param1: The description of param1
:param int param2: The description of param2

Admonition
----------

.. attention:: This is an attention admonition.
This is the second line of the first paragraph.

.. caution:: This is a caution admonition.
This is the second line of the first paragraph.

.. warning:: This is a warning admonition.
This is the second line of the first paragraph.

.. danger:: This is a danger admonition.
This is the second line of the first paragraph.

.. error:: This is an error admonition.
This is the second line of the first paragraph.

.. hint:: This is an hint admonition.
This is the second line of the first paragraph.

.. tip:: This is a tip admonition.
This is the second line of the first paragraph

.. important:: This is an important admonition.
This is the second line of the first paragraph.

.. note:: This is a note admonition.
This is the second line of the first paragraph.

.. admonition:: This is a general admonition.
This is the second line of the first paragraph.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Binary file added sample/build/html/_static/ajax-loader.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit eb55eb3

Please sign in to comment.