我想将我的项目包含README.md在我的Sphinx文档中,例如
Can sphinx链接到不在根文档下面的目录中的文档？
- 在生成的Sphinx html文档中,我点击欢迎页面上的目录中的链接,然后转到README.md.
为此,readme_link.rst创建了包含行的文档
Readme File
-----------
.. include:: ../../README.md
我添加了这一行
README <readme_link>
进入toctree index.rst.与此同时,我README.md不会被解析为Markdown,而只是按原样打印到页面上.
我认为另一个想法可能是改为使用markdown文件readme_link.md,但是没有办法包含markdown文件.
如何将我的README.md解析为markdown？
(当然我不想把它重写为.rst.)
我试图从.rst文件中的markdown文件中跟随Render输出,但这不起作用.我README.md有一些标题
# First heading
some text
## Second heading 1
some text
## Second heading 2
some text
我得到了错误WARNING: ../README.md:48: (SEVERE/4) Title level inconsistent:.我理解"标题级别不一致"是什么意思？我需要使用其他符号 - 但读入它们我意识到答案是指rst符号.这意味着我的降价自述文件实际上并未转化为rst.
PS:尝试类似这样的人的其他人是 https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/
我正在使用Sphinx为Python程序生成HTML文档.
我想使用具有特定标题的通用admonition指令(参见http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition)并以我可以定义的方式标记它例如,像使用note指令生成的内容,即盒装,但具有不同的颜色(大多数告诫不是特别设计的,参见http://sphinx.pocoo.org/rest.html?highlight=admonition).
我最好怎么做？
我目前正在使用Sphinx为一个相当复杂的Django网站编写一些大量文档.我一直在内部工作,在我很快离开之前,我想留下新的开发人员/管理员可以访问的详细文档.
我的问题是我有什么选择来托管这个文档？我希望它是私人的.文档也涉及网站而不是python包.出于这两个原因,我认为阅读文档可能不是最合适的选择.
我跑过django-sphinxdoc,虽然这需要设置Haystack作为后端.有没有办法简单地使用内置的js搜索服务器文档？或者允许私人托管文档的服务？
任何选项都将非常感激.
我有一个包含sphinx生成的文档的python包(使用自动模块功能),它可以被制作成一组静态html页面,位于项目的git存储库中的_build目录中.我想在bitbucket上以漂亮和私密的方式查看此文档.似乎wiki是一个git repo本身可能是可用的.
是否有一个简单的序列步骤可以将我的html文档转换为标记并将其推送到bitbucket wiki存储库？
我正在尝试为实际项目创建测试Python项目的文档.我的系统:Win7 64位,python 2.7.5 64位.
我的项目名称是testDoc.它包括名为t的 python pakage,它包含2个模块t1和t2和__init__.py.
__init__.py 包含:
import t1
import t2
t1.py包含:
'''
Created on 27 2013
@author:
'''
class MyClass(object):
'''
Hi
'''
def __init__(self,selfparams):
'''
Constructor
'''
pass
要创建文档,我在testDoc的命令行中运行:
sphinx-apidoc -A "me" -F -o docs .
Sphinx根据Sphinx文档创建了许多文件.然后,conf.py被修改
sys.path.insert(0, os.path.abspath(absolute path to testDoc))
我输入docs文件夹并输入
make html
并获得以下错误输出:
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building …我有一个.. toctreesphinx页面的一部分,其中包含rst我的包中其他文件的相对链接.如何包含指向给定页面的子部分的链接,而不是整页本身？
我捅了一下
.. toctree::
page#section
但那没用.任何帮助都很棒.
这是从sphinx doc中删除包和/或模块名称的任何方法吗？
示例:如果在模块foo.bar中存在一个名为waa的函数,则为第一个代码
.. automodule:: foo.bar
:members:
会产生
foo.bar.waa()
我想输出
waa()
在我的文档版本中,我一直收到警告"标题级别不一致".据我所知,我有一个一致的结构,看起来像:
Big Title
=========
Section
-------
Subsection
~~~~~~~~~~
但该错误与automodapi我无法追踪的autogenerated()文本相关联:
Classes
^^^^^^^
我怎样才能找出"不一致"的来源？
如果我这样做,sphinx-quickstart我会被问及项目的版本.
我想避免为我的项目版本提供两个位置.
如何在python包装世界中做到这一点？
像python或django的文档一样,我如何使用sphinx获得多个版本的doc？
我保存在我的git的文档,我希望我的用户能够看到文档不同版本的一样v2.7,v3.4等
感谢您的帮助