Skip to content

Commit

Permalink
fix build and man page generation
Browse files Browse the repository at this point in the history
  • Loading branch information
@christian-monch
christian-monch committed Apr 7, 2023
1 parent 5a78c10 commit a7a5a53
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 127 deletions.
136 changes: 14 additions & 122 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,15 @@
import os
import datetime
import subprocess
from os.path import join as opj, exists
from os.path import (
abspath,
dirname,
exists,
join as opj,
)
from os import pardir


def setup(sphinx):
sys.path.insert(0, os.path.abspath('utils')) # travis
sys.path.insert(0, os.path.abspath(opj(pardir, 'utils'))) # RTD
from pygments_ansi_color import AnsiColorLexer
sphinx.add_lexer("ansi-color", AnsiColorLexer)
import datalad_metalad


# If extensions (or modules to document with autodoc) are in another directory,
Expand Down Expand Up @@ -90,9 +86,6 @@ def setup(sphinx):
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

Expand All @@ -104,11 +97,8 @@ def setup(sphinx):
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
#version = '0.1'
# The full version, including alpha/beta/rc tags.
#release = '0.1.0'
version = datalad_metalad.__version__
release = version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -117,142 +107,44 @@ def setup(sphinx):
# Usually you set "language" from the command line for these cases.
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# 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 = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- 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 = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# 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 = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/datalad_logo.png'

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = ['_extras']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
html_split_index = True

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# smart quotes are incompatible with the RST flavor of the generated manpages
# but see `smartquotes_action` for more fine-grained control, in case
# some of this functionality is needed
smartquotes = False

# Output file base name for HTML help builder.
htmlhelp_basename = 'datalad_metaladdoc'
#htmlhelp_basename = 'datalad_metaladdoc'

# -- Options for LaTeX output ---------------------------------------------

Expand Down Expand Up @@ -303,10 +195,10 @@ def setup(sphinx):

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'datalad', u'datalad Documentation',
[author], 1)
]
#man_pages = [
# (master_doc, 'datalad', u'datalad Documentation',
# [author], 1)
#]

# If true, show URL addresses after external links.
#man_show_urls = False
Expand Down
17 changes: 12 additions & 5 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@

import versioneer

from _datalad_buildsupport.setup import (
BuildManPage,
)

cmdclass = versioneer.get_cmdclass()
cmdclass.update(build_manpage=BuildManPage)

# Give setuptools a hint to complain if it's too old a version
# 30.3.0 allows us to put most metadata in setup.cfg
Expand All @@ -18,7 +24,7 @@
setup(
name="datalad_metalad",
version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(),
cmdclass=cmdclass,
setup_requires=SETUP_REQUIRES,
packages=[
'datalad_metalad',
Expand All @@ -38,14 +44,15 @@
'datalad_metalad.pathutils',
'datalad_metalad.pathutils.tests',
'datalad_metalad.tests',
'datalad_metalad.metadatatypes'
'datalad_metalad.metadatatypes',
'_datalad_buildsupport',
],
package_dir={
'datalad_metalad.pipeline': 'datalad_metalad/pipeline'
'datalad_metalad.pipeline': 'datalad_metalad/pipeline',
},
package_data={
'datalad_metalad.pipeline': ['pipelines/*.json'],
'datalad_metalad.extractors.legacy.tests': ['data/*']
'datalad_metalad.extractors.legacy.tests': ['data/*'],
},
entry_points={
'datalad.extensions': [
Expand Down Expand Up @@ -81,6 +88,6 @@
],
'datalad.metadata.filters': [
'metalad_demofilter=datalad_metalad.filters.demofilter:DemoFilter',
]
],
},
)

0 comments on commit a7a5a53

Please sign in to comment.