![]() How many levels of the class index tree to By default onlyĪdditional plugin search paths. Which metadata fields should be formatted List of extra files to copy (for exampleĪdditional CSS files that are importedįrom the primary one). RelativeĪrbitrary JavaScript code or, for example,Īdditional properties and IDs that are Theme selection for more information.įallback. See Module inspection for moreĬorresponding to the CSS style. List of modules to generate the docs from. If not set, configįile base dir is used. PROJECT_SUBTITLE to the documentationīase input directory. URL of an image to use as a log in the top Options are similar to the Doxygen config,īut free of the Doxygen-specific naming and constraints. Mentioned above, the configuration file supports the following variables. Together with the above PROJECT_TITLE and INPUT_MODULES variables Can use both in-code docstrings and external reSTįiles to describe the APIs, giving the user a control over the code size vs.Does not force the documentation writer to explicitly list all symbols in.Signatures, does not rely on error-prone source code parsing Uses code inspection to query modules, classes, data, functions and their.Theme tailored from scratch for Python-specific language features.This will generate an output/ directory next to the conf.py file andįill it with the generated output. ![]() Now, run the script and pass path to the configuration file to it. We’ll generate documentation for the Python builtin math module: PROJECT_TITLE = "Python math" INPUT_MODULES = Inspect, how to name the project and where to put the output. Next, you need a configuration file which tells the script what modules to Package manager, in most cases you’ll probably have them already installed: # You may need sudo here You can install the dependencies via pip or your distribution The script requires Python 3.6 and depends on Jinja2įor templating and docutils for reST markup Into the documentation/ directory: git clone git:///mosra/m.css The base is contained in a single Python script and related style/templateįiles, for advanced features such as math rendering it’ll make use of internals Function signatures, property annotations.Including underscored names in the output.Class methods, static methods, dunder methods, properties.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |