如何编写OpenStack文档rst文件

如何编写OpenStack文档rst文件,第1张

两类文档

1) 程序员用败码的rest api文档用rst格式书写,

2)其他一些如deployers, admins, and CLI and API users用Docbook书写,

如果想要将rst文件生成html或者其和核他什么格式的话,需要安装python的sphinx模块,安装方法:pip install sphinx

一个关于sphinx的文档参见:http://code.google.com/p/pymotwcn/wiki/SphinxprojectHowto

1) 安装sphinx后,运行命令“sphinx-quickstart”可生成一个doc project,生成后的工程目录形如:

[hua@zhanghua tmp]$ ls

_build conf.py index.rst make.bat Makefile output _static _templates

2) 可用 sphinx-build -b html . output 或者 make html命令生成html文档,生成的文档位于output目录

[hua@zhanghua tmp]$ ls output/

察棚哪genindex.html index.html objects.inv search.html searchindex.js _sources _static

3) 将上面的rst文档例子test.rst作为链接添加到index.rst中来

Contents:

.. toctree::

:maxdepth: 2

doc/test.rst

前提:假设安装到轮世bbs文件夹下。将bbs/bin中的dll文件考到跟目录下面的bin中。将bbs/aspnet_client文件夹删除,注意是论坛bbs/中的,根目录下面的不要删除。c:/windows/temp文件夹要链桐铅有相应的 *** 作权限。

以上都已经 *** 作完毕,就可以采用下面的任何一种方法来解决了。

方法一:

你可以将 dnt.config和web.config拷到根目录下面。

方法二:

如果你的根目录下面有web.config时,不能这样做的话 ,你可以只将dnt.config拷到根目录下面。

以上两种都可以成功安装。

按第二种方法安装下去。提示成功以后。可能会出显首页空白的情棚好况,自己在安的过程中出现了,无法返回首页的提示。解决方法是:将bbs/web.config中的

<httpModules>

<add type="Discuz.Forum.HttpModule, Discuz.Forum" name="HttpModule" />

</httpModules>

剪切到根下面的web.config中,即可。

Dnt.config配置:

<?xml version="1.0"?>

<BaseConfigInfo xmlns:xsi=" http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd=" http://www.w3.org/2001/XMLSchema">

<Dbconnectstring>Data Source=127.0.0.1(IP)User ID=用户名Password=密码Initial Catalog=数据库名Pooling=true</Dbconnectstring>

<Tableprefix>dnt_</Tableprefix>

<Forumpath>/bbs/</Forumpath>

<Dbtype>SqlServer</Dbtype>

<Founderuid>1</Founderuid>

</BaseConfigInfo>

word文档内容对比,我有个更简单的办法:

用这个文本对比工具:

htt-ps://it365.gitlab.io/zh-cn/diff/?d17592

我留的链接有点问题,你先复制链接,粘贴到浏览器地址栏,把前面的htt-ps改为https再进去。

软件很简单,进去应该就会用了。

可能就是麻烦一点,要复制、粘贴几次,复制宴仔word内容,粘贴进去,就能看梁祥模到文档内容的差异对比了。

不过这个工具只是能分析出文字修改、标点符号的差异,不能分析出文档格式的变化,囧,希望能满足你的需求。

电脑上、手机上都可以使用的。

不知道能不能帮到你。

2个文档的文字比较效果

文档对比就是这么简单了。

修改了哪里橡缓、删除了哪里,都一清二楚。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/tougao/12353590.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-24
下一篇 2023-05-24

发表评论

登录后才能评论

评论列表(0条)

保存