1[epydoc] # Epydoc section marker (required by ConfigParser) 2 3# The list of objects to document. Objects can be named using 4# dotted names, module filenames, or package directory names. 5# Alases for this option include "objects" and "values". 6modules: mpi4py 7 8# The type of output that should be generated. Should be one 9# of: html, text, latex, dvi, ps, pdf. 10#output: html 11 12# The path to the output directory. May be relative or absolute. 13#target: docs/html/ 14 15# An integer indicating how verbose epydoc should be. The default 16# value is 0; negative values will supress warnings and errors; 17# positive values will give more verbose output. 18verbosity: 0 19 20# A boolean value indicating that Epydoc should show a tracaback 21# in case of unexpected error. By default don't show tracebacks 22#debug: 0 23 24# If True, don't try to use colors or cursor control when doing 25# textual output. The default False assumes a rich text prompt 26#simple-term: 0 27 28 29### Generation options 30 31# The default markup language for docstrings, for modules that do 32# not define __docformat__. Defaults to epytext. 33docformat: reStructuredText 34 35# Whether or not parsing should be used to examine objects. 36parse: yes 37 38# Whether or not introspection should be used to examine objects. 39introspect: yes 40 41# Don't examine in any way the modules whose dotted name match this 42# regular expression pattern. 43exclude: mpi4py\.(?!MPI) 44 45 46# Don't perform introspection on the modules whose dotted name match this 47# regular expression pattern. 48#exclude-introspect 49 50# Don't perform parsing on the modules whose dotted name match this 51# regular expression pattern. 52#exclude-parse 53 54# The format for showing inheritance objects. 55# It should be one of: 'grouped', 'listed', 'included'. 56inheritance: listed 57 58# Whether or not to inclue private variables. (Even if included, 59# private variables will be hidden by default.) 60private: yes 61 62# Whether or not to list each module's imports. 63imports: no 64 65# Whether or not to include syntax highlighted source code in 66# the output (HTML only). 67sourcecode: yes 68 69# Whether or not to include a a page with Epydoc log, containing 70# effective option at the time of generation and the reported logs. 71include-log: no 72 73 74### Output options 75 76# The documented project's name. 77name: MPI for Python 78 79# The documented project's URL. 80url: https://github.com/mpi4py/mpi4py 81 82# The CSS stylesheet for HTML output. Can be the name of a builtin 83# stylesheet, or the name of a file. 84css: white 85 86# HTML code for the project link in the navigation bar. If left 87# unspecified, the project link will be generated based on the 88# project's name and URL. 89#link: <a href="somewhere">My Cool Project</a> 90 91# The "top" page for the documentation. Can be a URL, the name 92# of a module or class, or one of the special names "trees.html", 93# "indices.html", or "help.html" 94#top: os.path 95 96# An alternative help file. The named file should contain the 97# body of an HTML file; navigation bars will be added to it. 98#help: my_helpfile.html 99 100# Whether or not to include a frames-based table of contents. 101frames: yes 102 103# Whether each class should be listed in its own section when 104# generating LaTeX or PDF output. 105separate-classes: no 106 107 108### API linking options 109 110# Define a new API document. A new interpreted text role 111# will be created 112#external-api: epydoc 113 114# Use the records in this file to resolve objects in the API named NAME. 115#external-api-file: epydoc:api-objects.txt 116 117# Use this URL prefix to configure the string returned for external API. 118#external-api-root: epydoc:http://epydoc.sourceforge.net/api 119 120 121### Graph options 122 123# The list of graph types that should be automatically included 124# in the output. Graphs are generated using the Graphviz "dot" 125# executable. Graph types include: "classtree", "callgraph", 126# "umlclasstree". Use "all" to include all graph types 127graph: classtree 128 129# The path to the Graphviz "dot" executable, used to generate 130# graphs. 131#dotpath: /usr/local/bin/dot 132 133# The name of one or more pstat files (generated by the profile 134# or hotshot module). These are used to generate call graphs. 135#pstat: profile.out 136 137# Specify the font used to generate Graphviz graphs. 138# (e.g., helvetica or times). 139graph-font: Helvetica 140 141# Specify the font size used to generate Graphviz graphs. 142graph-font-size: 10 143 144 145### Return value options 146 147# The condition upon which Epydoc should exit with a non-zero 148# exit status. Possible values are error, warning, docstring_warning 149#fail-on: error 150