我想为一个名为 Ulyxes PyAPI 的 API 制作文档。我已经启动了它,但是自动生成过程不起作用。当我在我的 index.html 页面中单击自动生成的文档链接时,我被称为一个没有关于我的类和类函数的信息的空页面
实际上,我的 API 中有一个 10 多个 python 文件,每个文件都包含一个类模型测量传感器(机器人全站仪、GPS 等)。在这个问题中,我只写了一小部分,以使我的问题易于理解。
我认为,无论是 code.rst 还是 leicameasureunit.py 都是错误的......
*.py 和 *.srt 文件位于我的工作目录相同的目录中。我使用的是windows 7操作系统。
非常感谢!
...\UlyxesPyApiDoc:
文件如下:
索引.srt:
.. Ulyxes PyAPI documentation master file, created by
sphinx-quickstart on Mon Oct 21 20:53:48 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Ulyxes PyAPI 's documentation!
=========================================
Ulyxes is an open source project to drive robotic total stations (RTS) and other
sensors and publish observation results on web based maps (GPL 2).
Requirmenets:
Contents:
.. toctree::
:maxdepth: 2
project
tutorial
code
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
代码.rst:
Auto Generated Documentation
============================
.. autoclass:: leicameasureunit
:members:
项目.srt:
Project Summary
===============
Goals Achieved
--------------
Goal 1 to create a framework to drive robotic total stations from a computer and publish data on the Internet
Goal 2 we want to create a framework not a ready to use application
Goal 3 the project is based on several other open source projects
教程.srt:
Tutorial for driving RTSs
=========================
This is a short description about how to drive RTSs via serial port from PC/laptop
leicameasureunit.py:`
"""
Created on 29 July 2012
@author: Dani Moka
"""
from measureunit import *
from angle import *
import re
class LeicaMeasureUnit(MeasureUnit):
"""
This class models Leica robotic totals stations
"""
def __init__(self, name = 'Leica generic', type = 'TPS'):
# call super class init
super(LeicaMeasureUnit, self).__init__(name, type)
def MoveMsg(self, hz, v, units='RAD', atr=0):
"""
This function make instruments moving.
:arguments:
hz
Direction 1
units
uints in default RAD
"""
hz_rad = Angle(hz, units).GetAngle('RAD')
v_rad = Angle(v, units).GetAngle('RAD')
return '%%R1Q,9027:%f,%f,0,%d,0' % (hz_rad, v_rad, atr)
def SetATRMsg(self, atr):
"""
This function used for setting Automatic Target Recognition
:arguments:
atr
1 - on / 2 - off
units
1 - on / 2 - off
"""
return '%%R1Q,9018:%d' % (atr)
def GetATRMsg(self):
"""
This function used for getting the status of Automatic Target Recognition
"""
return '%R1Q,9019:'
`