def run(self):
if self.force or not self.skip():
# generate man pages -- html versions of man pages are provided
self.run_command('build_man')
# generate API docs
generate_html()
# generate html docs -- allow build_sphinx cmd to run again
build_sphinx = self.reinitialize_command('build_sphinx')
build_sphinx.builder = 'html'
build_sphinx.ensure_finalized()
self.run_command('build_sphinx')
def run(self):
if self.force or not self.skip():
# generate man pages -- html versions of man pages are provided
self.run_command('build_man')
# generate API docs
from snakeoil.dist.generate_docs import generate_html
generate_html(PROJECT, TOPDIR)
# generate html docs -- allow build_sphinx cmd to run again
build_sphinx = self.reinitialize_command('build_sphinx')
build_sphinx.builder = 'html'
build_sphinx.ensure_finalized()
self.run_command('build_sphinx')
def run(self):
if self.force or not self.skip():
# generate man pages -- html versions of man pages are provided
self.run_command('build_man')
# generate API docs
from snakeoil.dist.generate_docs import generate_html
generate_html(PROJECT, TOPDIR)
# generate html docs -- allow build_sphinx cmd to run again
build_sphinx = self.reinitialize_command('build_sphinx')
build_sphinx.builder = 'html'
build_sphinx.ensure_finalized()
self.run_command('build_sphinx')
def _generate_doc_content(self):
# generate man pages -- html versions of man pages are provided
self.run_command('build_man')
# generate API docs
generate_html()
def generate_html():
"""Generate html docs for the project."""
from snakeoil.dist.generate_docs import generate_html
generate_html(REPODIR, PACKAGEDIR, MODULE_NAME)
def _generate_doc_content(self):
# generate man pages -- html versions of man pages are provided
self.run_command('build_man')
# generate API docs
generate_html()
def generate_html():
"""Generate html docs for the project."""
from snakeoil.dist.generate_docs import generate_html
generate_html(REPODIR, PACKAGEDIR, MODULE_NAME)
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# auto-generate required files for RTD build environment
project_dir = os.path.abspath('..')
if on_rtd:
generate_man(project, project_dir)
generate_html(project, project_dir)
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# auto-generate required files for RTD build environment
if on_rtd:
generate_man(project, const.DATA_PATH)
generate_html(project, const.DATA_PATH)
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinxdoc'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# auto-generate required files for RTD build environment
project_dir = os.path.abspath('..')
if on_rtd:
generate_man(project, project_dir)
generate_html(project, project_dir)
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# auto-generate required files for RTD build environment
if on_rtd:
generate_man(project, const.DATA_PATH)
generate_html(project, const.DATA_PATH)
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinxdoc'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
