文件列表:

LICENSE (1062, 2020-03-29)
coordinate_tools.py (10207, 2020-03-29)
docs (0, 2020-03-29)
docs\Makefile (638, 2020-03-29)
docs\UML (1968, 2020-03-29)
docs\make.bat (764, 2020-03-29)
docs\source (0, 2020-03-29)
docs\source\conf.py (2004, 2020-03-29)
docs\source\index.rst (574, 2020-03-29)
kinematics-unittest.py (2824, 2020-03-29)
kinematics.py (12977, 2020-03-29)
main.py (245, 2020-03-29)
robotic.py (1800, 2020-03-29)
serial-python-to-arduino (0, 2020-03-29)

# Use sphinx for documenation with python ## Initialize sphinx ```sphinx-quickstart``` ## Configure sphinx conf.py file * conf.py must contain project name, author and version. * conf.py must define a path to load modules from (absolute path is helpful, since docs is a subfolder of the projectfolder [i.e. RoboticArm]) ```sys.path.insert(0, 'C:\\Users\\David\\source\\repos\\RoboticArm')``` * conf.py must load extension -> add them to array ```extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.autosummary']``` * conf.py recommended html template: sphinx_rtd_theme index.rst file should have something like the following structure: ``` .. toctree:: .. autosummary:: :toctree: _autosummary main :members: mein :members: .. automodule:: main :members: .. automodule:: mein :members: ``` Please not that "mein" and "main" are python modules, which are located in the directory specified in conf.py Apart from mentioning all the relevent modules in the autosummary tab, it is necessary to specify the moduls. Please not that sphinx runs each module as it builds the html-doc. Thus, moduls containing executable code should not be contained in the API doc. ## Generate documentation ```sphinx-apidoc -o . ..``` ```make html```

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：