将excel文件作为一个类似excel的表嵌入到sphinx文档中。
sphinxcontrib-excel的Python项目详细描述
sphinxcontrolib excel使用pyexcel读取excel文件，并将其呈现到sphinx文档中类似于excel的工作表中。excel文件格式为：
- CSV
- tsv
- CSVZ
- tsvz
- xls
- xlsx
- XLSM
- ODS
安装
您可以通过pip安装它：
$ pip install sphinxcontrib-excel
或者克隆并安装：
$ git clone https://github.com/pyexcel/sphinxcontrib-excel.git
$ cd sphinxcontrib-excel
$ python setup.py install
设置
请将SphinxContrib Excel添加到conf.py文件中：
extensions = [
...
'sphinxcontrib.excel',
...
]
您需要将一些资源文件复制到sphinx源目录：
resources/_template/layout.html resources/_static/handsontable.full.min.js resources/_static/handsontable.full.min.css
注意
资源目录在github中。请检查一下。
以下是在Sphinx文档中显示Excel文件的语法：
.. pyexcel-table:: filename.csv
在引用的rst文件所在的目录中需要“filename.csv”。 如果文件在其他地方，则需要给出相对路径。
例如，以下第一个语句：
翻译为：
将csv嵌入sphinx文档
下面是嵌入式csv的语法rendering as a single handsontable：
.. pyexcel-table:: ---pyexcel:example table--- Name,Age Adam,28 Beatrice,29 Ceri,30 Dean,26
下面是一个复杂的嵌入式csv示例，它将是rendered as multi-tab handsontable）：
.. pyexcel-table:: ---pyexcel:Sheet 1--- 1,2,3 4,5,6 7,8,9 ---pyexcel--- ---pyexcel:Sheet 2--- X,Y,Z 1,2,3 4,5,6 ---pyexcel--- ---pyexcel:Sheet 3--- O,P,Q 3,2,1 4,3,2
支持项目
如果您的公司已经将pyexcel及其组件嵌入到一个产生收入的 产品，请support me on patreon到 维护项目并进一步发展。
如果你是个人，欢迎你支持我在帕特伦，无论多久 你想去。作为帕特伦人，你会得到 early access to pyexcel related contents。
有你的经济支持，我可以投资 在编码、文档和写有趣的文章上多花点时间。
开发指南
代码更改的开发步骤
- git克隆https://github.com/pyexcel/sphinxcontrib-excel.git
- CD SphinxContrib Excel
升级安装工具和pip。它们仅用于开发和测试：
- pip安装-升级setuptools pip
然后安装相关的开发要求：
- PIP-Real-RrNdReavest.txt>如果该文件存在
- pip install-r requirements.txt
- pip安装-r tests/requirements.txt
为了更新测试环境和文档，其他步骤如下 必需：
- pip安装moban
- git克隆https://github.com/pyexcel/pyexcel-commons.git公共空间
- 在.moban.d目录中进行更改，然后发出命令moban
什么是rnd_requirements.txt
通常，它是在依赖库未被释放时创建的。一旦安装了依赖项（将被发布），requirements.txt中的依赖项的未来版本将有效。
什么是pyexcel commons
许多跨pyexcel项目共享的信息，例如：本开发人员指南、许可证信息等，都存储在pyexcel commonsproject中。
什么是.moban.d
.moban.d存储库的特定元数据。
如何测试您的贡献
尽管nose和doctest都用于代码测试，但是将单元测试放在测试中是可取的。doctest的合并只是为了确保文档中的代码示例在不同的开发版本中保持有效。
在Linux/Unix系统上，请启动如下测试：
$ make
在Windows系统上，请发出以下命令：
> test.bat
许可证
新的BSD许可证
欢迎加入QQ群-->： 979659372
