Question

在Pycharm中工作时，我在sphinx中创建的文档的预览模式显示：

class Project(models.Model):

    id = models.BigAutoField(primary_key=True)
    name = models.CharField(max_length=20 , unique=True)
    startDate = models.DateField(default=timezone.now)
    endDate = models.DateField()
    sourceOfProject = models.CharField(default='Website',  verbose_name='Project Source',max_length=20 , choices=(('Website' , 'Website'),('Client','Client')))  # website or client etc
    sourceName = models.CharField(default='' , verbose_name='Source Name' , max_length=20)
    paymentType = models.CharField(default='Fixed' , verbose_name='Payment Type', max_length=20 , choices=(('Hourly','Hourly'),('Fixed','Fixed')))  # If True then hourly else fixed
    ProjectPaymentAmount = models.PositiveIntegerField(verbose_name='Amount')  # this amount is according to hourlyPayment==True or False
    is_Active = models.BooleanField(default=True)
    projectSeverity = models.PositiveIntegerField(default=1, choices=SEVERITY_CHOICES)
    hubstaffName = models.CharField(max_length=30, null=True , default='')
    hoursToWork = models.PositiveIntegerField()


    def __str__(self):
        return "Project: {}".format(self.name)

我在conf.py文件中包含了'autodoc'扩展名。当我打开/build/index.html文件时，它工作正常。因此，我的问题是：如何从pycharm预览模式中删除此错误，以便可以预览文档而不必一直打开/build/index.html文件？

Answer 1

Sphinx建立在Docutils库的顶部。 toctree指令可用于Sphinx，但Docutils无法识别。

PyCharm预览器不使用Sphinx（对于免费社区版和专业版，自2019年开始适用）；它可能使用了Docutils的rst2html.py。

此邮件列表线程大约具有相同的错误：https://mail.python.org/pipermail/python-list/2008-June/493826.html。

Sphinx：未知的指令类型“ toctree”。 Pycharm中的错误，但index.html可以工作

1 个答案: