基于sphinx新闻主题的sphinx文档主题
sphinx-heigvd-theme的Python项目详细描述
#Sphinx Heig-VD主题
这个主题是[sphinx press theme]的一个分支(https://schettino72.github.io/sphinx_press_site/) 基于[vuepress](https://vuepress.vuejs.org/)。它使用[vue.js](https://vuejs.org/)和[Stylus](http://stylus-lang.com/) 由[webpack](https://webpack.js.org/)管理(通过[vue cli](https://cli.vuejs.org/))。
##安装
首先安装主题:
` $ pip install git+https://github.com/heig-vd-tin/sphinx-heigvd-theme `
在sphinx项目的conf.py:将主题名设置为heigvd。
` html_theme = "heigvd" `
请参阅[Sphinx主题文档](http://www.sphinx-doc.org/en/master/theming.html#using-a-theme)的详细信息。
##开发
要对此主题作出贡献,您应该首先构建Web资产:
` cd ui npm run build `
sphinx主题与构建的资产有一个软链接。完成后,在本地安装主题 使用pip安装-e.。
文档文件夹包含主题自己的文档。
` cd docs make clean; make html `