Skip to content

Commit

Permalink
feat(resource&theme): switch theme. Add structured content of resource
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyame committed Sep 3, 2020
1 parent b6013d6 commit e93df0d
Show file tree
Hide file tree
Showing 5 changed files with 388 additions and 8 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# OneTweBot用户文档

![](https://img.shields.io/static/v1?label=Nonebot&message=1.7.0&color=green&style=flat-square&link=https://github.com/nonebot/nonebot) ![](https://img.shields.io/static/v1?label=Python&message=3.7&color=blue&style=flat-square&link=https://www.python.org/) ![](https://img.shields.io/static/v1?label=LICENSE&message=MIT&color=red&style=flat-square&link=https://github.com/chenxuan353/tweetToBot/blob/v3/LICENSE) ![](https://img.shields.io/static/v1?label=cqhttp-mirai&message=4.8&color=9cf&style=flat-square&link=https://github.com/yyuueexxiinngg/cqhttp-mirai) ![](https://img.shields.io/static/v1?label=MIRAI&message=3.7&color=9cf&style=flat-square&link=https://github.com/mamoe/mirai) ![](https://img.shields.io/static/v1?label=CQHTTP&message=4.8&color=brightgreen&style=flat-square&link=https://github.com/nonebot/aiocqhttp) ![](https://img.shields.io/static/v1?label=go-cqhttp&message=stable&color=brightgreen&style=flat-square&link=https://github.com/Mrs4s/go-cqhttp) ![](https://img.shields.io/static/v1?label=sphinx&message=4.0&color=blue&style=flat-square&link=https://www.sphinx-doc.org/en/master)
![](https://img.shields.io/static/v1?label=Nonebot&message=1.7.0&color=green&style=flat-square&link=https://github.com/nonebot/nonebot) ![](https://img.shields.io/static/v1?label=Python&message=3.7&color=blue&style=flat-square&link=https://www.python.org/) ![](https://img.shields.io/static/v1?label=LICENSE&message=MIT&color=red&style=flat-square&link=https://github.com/chenxuan353/tweetToBot/blob/v3/LICENSE) ![](https://img.shields.io/static/v1?label=cqhttp-mirai&message=0.2.3&color=9cf&style=flat-square&link=https://github.com/yyuueexxiinngg/cqhttp-mirai) ![](https://img.shields.io/static/v1?label=Mirai&message=1.2.2&color=9cf&style=flat-square&link=https://github.com/mamoe/mirai) ![](https://img.shields.io/static/v1?label=CQHTTP&message=4.8&color=brightgreen&style=flat-square&link=https://github.com/nonebot/aiocqhttp) ![](https://img.shields.io/static/v1?label=go-cqhttp&message=stable&color=brightgreen&style=flat-square&link=https://github.com/Mrs4s/go-cqhttp) ![](https://img.shields.io/static/v1?label=sphinx&message=4.0&color=blue&style=flat-square&link=https://www.sphinx-doc.org/en/master) ![](https://img.shields.io/static/v1?label=commitzen&message=friendly&color=brightgreen&style=flat-square&link=http://commitizen.github.io/cz-cli/)

**此分支为项目文档所在分支**
#### [用户文档](https://bothbot-documentation.readthedocs.io/)

**此分支为OneTweBot项目文档仓库**
项目主仓库目前位于[tweetToBot](https://github.com/chenxuan353/tweetToBot)

文档使用Python项目通用的[sphinx](https://www.sphinx-doc.org/en/master/index.html)进行部署和编写。基于Readthedocs提供的[sphinx_rtd_theme](https://github.com/rtfd/sphinx_rtd_theme)进行风格化构建。

Expand Down Expand Up @@ -56,11 +59,11 @@ sphinx-build -b html source static

##### 生成PDF手册

*中文字体似乎问题,请使用ReadTheDocs托管处生成的PDF*
*本地生成PDF时中文字体似乎问题,请使用ReadTheDocs托管处生成的PDF*

```shell

./make pdf
./make latexpdf

```

Expand Down
3 changes: 2 additions & 1 deletion requirement.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sphinx
sphinx-autobuild
sphinx-rtd-theme
recommonmark
recommonmark
rst2pdf
10 changes: 7 additions & 3 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import sphinx_rtd_theme

# import guzzle_sphinx_theme
# import sphinx_rtd_theme
# import rst2pdf
# import recommonmark
# -- Project information -----------------------------------------------------
Expand All @@ -35,7 +37,8 @@
master_doc = 'index'

extensions = [
"sphinx_rtd_theme",
# "sphinx_rtd_theme",
# "guzzle_sphinx_theme",
"recommonmark",
"sphinx.ext.autodoc",
# "rst2pdf.pdfbuilder"
Expand All @@ -62,7 +65,8 @@
# 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 = 'bizstyle'
# html_theme_path = guzzle_sphinx_theme.html_theme_path()
#html_theme = 'classic'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
1 change: 1 addition & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
OneTweBot项目文档
====================================================


------------------------
项目简介
------------------------
Expand Down

0 comments on commit e93df0d

Please sign in to comment.