sphinx documentation generator

Sphinx introducation: Python documentation Generator Author: Chao Zhong (zhongchao) Email: zhongchao. USTC # gmail.com (#-> @) Blog: blog.csdn.net/poechant Date: SEP 30,201 2 0 install sphinx easy_install -U Sphinx1 build project1.1 sphinx-Quickstart michael@ubuntu:~/r

Installation sudo pip install Sphinx ClassEnter the directory where your code is located and type the following Sphinx-quickstart Will come out a series of items to be filled in, according to my fill in the Welcome to the Sphinx 1.2.3 QuickStart utility. Please enter values for the following settings (just press ENTER toAccept a default value, if one is given in

internal or external commands. When you install Python, environment variables are not set. Add the environment variable, adding the scripts under the Python directory to the path of the environment variable. Execution Sphinx-build--version will have the relevant version information. Description Sphinx-build Available 5. Under command line, CD to the document directory that needs to be converted, and

Sphinx can generate API documents that can be found based on Python annotations, and simply record the next steps1 : Install pip install-u Sphinx2: Execute Sphinx-apidoc-f-O./doc under the directory where the. py file is required to generate the document./domain/model/the new Doc directory under the current directory, the folder for the API documentation is in t

Amoy to a makefile, back up a bit. #makefileforsphinxdocumentation##youcansetthesevariables fromthecommandline. sphinxopts=sphinxbuild=sphinx-buildpaper =BUILDDIR=build# user-friendlycheckforsphinx-buildifeq ($ (shellwhich$ (SPHINXBUILD) > /dev/null2>1;echo$$, 1) $ (errorthe ' $ (sphinxbuild) ' command wasnotfound.makesureyouhavesphinxinstalled,then settheSPHINXBUILDenvironmentvariabletopointtothe fullpathofthe ' $ (sphinxbuild) ' executable.alternati

functions.Basically the same as the previous version of the code generator.But the function is not enough.So we're going to say the next thing.Road Map Generate a Readme manual Perfecting the code of the infrastructure layer Perfect bug Add code snippets for the view layer. Also welcome to: Https://github.com/52ABP/52ABP.CodeGeneratorWelcome to Star and then present your thoughts and comments.Now the resultsThe current version is still 1.0 follow-up to do more iteratio