예제 #1
0
    def run(self):
        if self.force or not self.skip():
            # TODO: report this to upstream sphinx
            #
            # Workaround for sphinx doing include directive path mangling in
            # order to interpret absolute paths "correctly", but at the same
            # time causing relative paths to fail. This just bypasses the
            # sphinx mangling and lets docutils handle include directives
            # directly which works as expected.
            from docutils.parsers.rst.directives.misc import Include as BaseInclude
            from sphinx.directives.other import Include
            Include.run = BaseInclude.run

            # Use a built version for the man page generation process that
            # imports script modules.
            build_py = self.reinitialize_command('build_py')
            build_py.ensure_finalized()
            self.run_command('build_py')
            with syspath(os.path.abspath(build_py.build_lib)):
                # generate man page content for scripts we create
                if 'build_scripts' in self.distribution.cmdclass:
                    generate_man()

                # generate man pages
                build_sphinx = self.reinitialize_command('build_sphinx')
                build_sphinx.builder = 'man'
                build_sphinx.ensure_finalized()
                self.run_command('build_sphinx')
예제 #2
0
    def run(self):
        if self.force or not self.skip():
            # Use a built version for the man page generation process that
            # imports script modules.
            build_py = self.reinitialize_command('build_py')
            build_py.ensure_finalized()
            self.run_command('build_py')
            with syspath(os.path.abspath(build_py.build_lib)):
                # generate man page content for scripts we create
                if 'build_scripts' in self.distribution.cmdclass:
                    generate_man()

                # generate man pages
                build_sphinx = self.reinitialize_command('build_sphinx')
                build_sphinx.builder = 'man'
                build_sphinx.ensure_finalized()
                self.run_command('build_sphinx')
예제 #3
0
    def run(self):
        if self.force or not self.skip():
            # Use a built version for the man page generation process that
            # imports script modules.
            build_py = self.reinitialize_command('build_py')
            build_py.ensure_finalized()
            self.run_command('build_py')
            syspath = sys.path[:]
            sys.path.insert(0, os.path.abspath(build_py.build_lib))

            # generate man page content for scripts we create
            if 'build_scripts' in self.distribution.cmdclass:
                from snakeoil.dist.generate_docs import generate_man
                generate_man(PROJECT, TOPDIR)

            # generate man pages
            build_sphinx = self.reinitialize_command('build_sphinx')
            build_sphinx.builder = 'man'
            build_sphinx.ensure_finalized()
            self.run_command('build_sphinx')
            sys.path = syspath
예제 #4
0
파일: pkgdist.py 프로젝트: 4eetah/snakeoil
    def run(self):
        if self.force or not self.skip():
            # Use a built version for the man page generation process that
            # imports script modules.
            build_py = self.reinitialize_command('build_py')
            build_py.ensure_finalized()
            self.run_command('build_py')
            syspath = sys.path[:]
            sys.path.insert(0, os.path.abspath(build_py.build_lib))

            # generate man page content for scripts we create
            if 'build_scripts' in self.distribution.cmdclass:
                from snakeoil.dist.generate_docs import generate_man
                generate_man(PROJECT, TOPDIR)

            # generate man pages
            build_sphinx = self.reinitialize_command('build_sphinx')
            build_sphinx.builder = 'man'
            build_sphinx.ensure_finalized()
            self.run_command('build_sphinx')
            sys.path = syspath
예제 #5
0
 def _generate_doc_content(self):
     # generate man page content for scripts we create
     if 'build_scripts' in self.distribution.cmdclass:
         generate_man()
예제 #6
0
def generate_man():
    """Generate man pages for the project."""
    from snakeoil.dist.generate_docs import generate_man
    generate_man(REPODIR, PACKAGEDIR, MODULE_NAME)
예제 #7
0
 def _generate_doc_content(self):
     # generate man page content for scripts we create
     if 'build_scripts' in self.distribution.cmdclass:
         generate_man()
예제 #8
0
def generate_man():
    """Generate man pages for the project."""
    from snakeoil.dist.generate_docs import generate_man
    generate_man(REPODIR, PACKAGEDIR, MODULE_NAME)
예제 #9
0
# 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 = []

# 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 = []
예제 #10
0
# unit titles (such as .. function::).
#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 = []
예제 #11
0
파일: conf.py 프로젝트: den4ix/pkgcheck
# 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 = []

# 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 = []
예제 #12
0
파일: conf.py 프로젝트: den4ix/pkgcore
# unit titles (such as .. function::).
#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 = []