Merge pull request #3 from ginnko/version-1.0.0

finish v1.0.0 of the sphinx_ustack_theme

MANIFEST.in

@@ -1,11 +1,11 @@
 include *.txt
 include LICENSE
-recursive-include sphinx_rtd_theme *.conf
-recursive-include sphinx_rtd_theme *.css
-recursive-include sphinx_rtd_theme *.eot
-recursive-include sphinx_rtd_theme *.html
-recursive-include sphinx_rtd_theme *.js
-recursive-include sphinx_rtd_theme *.svg
-recursive-include sphinx_rtd_theme *.ttf
-recursive-include sphinx_rtd_theme *.woff
-recursive-include sphinx_rtd_theme *.woff2
+recursive-include sphinx_ustack_theme *.conf
+recursive-include sphinx_ustack_theme *.css
+recursive-include sphinx_ustack_theme *.eot
+recursive-include sphinx_ustack_theme *.html
+recursive-include sphinx_ustack_theme *.js
+recursive-include sphinx_ustack_theme *.svg
+recursive-include sphinx_ustack_theme *.ttf
+recursive-include sphinx_ustack_theme *.woff
+recursive-include sphinx_ustack_theme *.woff2

README.rst

@@ -1,54 +1,34 @@
 
-**************************
-Read the Docs Sphinx Theme
-**************************
-
-.. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
-   :target: https://pypi.python.org/pypi/sphinx_rtd_theme
-   :alt: Pypi Version 
-.. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master
-   :target: https://travis-ci.org/rtfd/sphinx_rtd_theme
-   :alt: Build Status
-.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
-   :target: https://pypi.python.org/pypi/sphinx_rtd_theme/
-   :alt: License
-.. image:: https://readthedocs.org/projects/sphinx-rtd-theme/badge/?version=latest
-  :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
-  :alt: Documentation Status
-
-The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly.
-This theme is primary focused to be used on readthedocs.org_ but can work with your
-own sphinx projects. To read more and see a working demo_ head over to readthedocs.org_.
-
-.. _sphinx: http://www.sphinx-doc.org
-.. _readthedocs.org: http://www.readthedocs.org
-.. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/
-
-
-Installing
-==========
 
-The theme is distributed on PyPI_ and can be installed with pip::
 
-   pip install sphinx_rtd_theme
+====================
+sphxin_ustack_theme
+====================
+
+
+``sphinx_ustack_theme`` 基于 ``sphinx_rtd_theme`` 主题修改而成，原主题请点击 这里_。
 
-For more information read the full installing docs
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html>`__.
 
-.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
+.. _这里: https://github.com/rtfd/sphinx_rtd_theme
+
+安装
+==========
 
+使用pip安装:
 
-Configuration
+   pip install sphinx_ustack_theme
+
+
+配置
 =============
 
-The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level.
-To see all the possible configuration options read the configuring docs
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__.
+使用本主题请在 ``conf.py`` 文件中包含下列代码来引入本主题
+
+  import sphinx_ustack_theme
+
+  html_theme = 'sphinx_ustack_theme'
+
+其他配置请参考 ``sphinx_rtd_theme`` 主题，点击 `这里 <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__。
 
 
-Contributing
-============
 
-If you would like to help improve the theme or have more control
-over the theme in case of a fork please read our contributing guide
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.

docs/conf.py

@@ -18,7 +18,7 @@
 sys.path.append(os.path.abspath('..'))
 sys.path.append(os.path.abspath('./demo/'))
 
-from sphinx_rtd_theme import __version__
+# from sphinx_ustack_theme import __version__
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -56,21 +56,21 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Read the Docs Sphinx Theme'
-copyright = u'Dave Snider, Read the Docs, Inc. & contributors'
+project = u'UDS文档'
+# copyright = u'Dave Snider, Read the Docs, Inc. & contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = __version__
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = __version__
+# release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-language = 'en'
+language = 'zh_CN'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -109,7 +109,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'sphinx_ustack_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -130,7 +130,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-html_logo = "demo/static/logo-wordmark-light.svg"
+# html_logo = "demo/static/logo-wordmark-light.svg"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -167,13 +167,13 @@
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+html_show_copyright = False
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the

docs/make.bat

@@ -1,38 +1,38 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=python -msphinx
-)
-set SPHINXOPTS=
-set SPHINXBUILD=sphinx-build
-set SOURCEDIR=.
-set BUILDDIR=build
-set SPHINXPROJ=ReadtheDocsSphinxTheme
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
-	echo.then set the SPHINXBUILD environment variable to point to the full
-	echo.path of the 'sphinx-build' executable. Alternatively you may add the
-	echo.Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SPHINXOPTS=
+set SPHINXBUILD=sphinx-build
+set SOURCEDIR=.
+set BUILDDIR=build
+set SPHINXPROJ=ReadtheDocsSphinxTheme
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

sass/_theme_breadcrumbs.sass

@@ -32,3 +32,17 @@
 @media print
   .wy-breadcrumbs li.wy-breadcrumbs-aside
     display: none
+
+
+// custom style
+ul.wy-breadcrumbs
+  li
+    font-size: 14px
+    color:  #6C777A
+    letter-spacing: 0.5px
+    line-height: 24px
+    a
+      font-size: 14px
+      color: #01AFC9
+      letter-spacing: 0.5px
+      line-height: 24px