Mercurial > public > mercurial-scm > evolve

comparison docs/conf.py @ 2959:ef361938dfa1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: integrate graphviz graphs in tutorials Use the mercurial-docgraph extension (https://pypi.python.org/pypi/hg- docgraph/) in tutorials in order to have some dot graphs in the tutorials .t files. Then generate the doc as usual, the sphinx-graphviz extension (http://www .sphinx-doc.org/en/stable/ext/graphviz.html) has been added and it should handle the generation of the graphs. Please be aware that you need the dot binary installed in your system. Please refer to the extension documentation for more configuration.
author Boris Feld <boris.feld@octobus.net>
date Thu, 21 Sep 2017 10:45:27 +0200
parents 2ddc63d13af8
children 3f466d348047
comparison
equal deleted inserted replaced
2958:1cb715257130 2959:ef361938dfa1
1 # Add any Sphinx extension module names here, as strings. They can be extensions 1 # Add any Sphinx extension module names here, as strings. They can be extensions
2 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 2 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3 extensions = [] 3 extensions = ["sphinx.ext.graphviz"]
4 # autoclass_content = 'both' 4 # autoclass_content = 'both'
5 # Add any paths that contain templates here, relative to this directory. 5 # Add any paths that contain templates here, relative to this directory.
6 # templates_path = [] 6 # templates_path = []
7 7
8 # The suffix of source filenames. 8 # The suffix of source filenames.
120 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). 120 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
121 # html_file_suffix = '.html' 121 # html_file_suffix = '.html'
122 122
123 # Output file base name for HTML help builder. 123 # Output file base name for HTML help builder.
124 # htmlhelp_basename = '' 124 # htmlhelp_basename = ''
125
126 graphviz_output_format = "svg"