Exemplo n.º 1
0
import sys

import sphinx_readable_theme

sys.path.append(path.abspath(path.dirname(__file__) + "../../../"))

# General configuration
# ---------------------

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
              'sphinx.ext.coverage',
              'sphinx.ext.inheritance_diagram']

html_theme_path = [sphinx_readable_theme.get_html_theme_path()]
html_theme = 'readable'

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General substitutions.
project = 'flatland'
copyright = '2008, the flatland authors and contributors'
Exemplo n.º 2
0
autodoc_default_flags = ["members"]
autoclass_content = "init"
napoleon_include_special_with_doc = True
source_suffix = [".rst"]

language = None
exclude_patterns = ["_build"]

pygments_style = "trac"
add_module_names = False
add_function_parentheses = False
todo_include_todos = True

html_theme = "readable"
html_theme_path = [sphinx_readable_theme.get_html_theme_path()]
# html_theme = "alabaster"
# html_theme_options = {
#     "logo": "tmp_logo.jpg",
#     "logo_name": True,
#     "show_powered_by": False,
#     "github_user": "******",
#     "github_repo": "glyph",
#     "github_banner": True,
#     "github_type": "star",
#     "show_related": False,
#     "description": "Symbolic regression tools.",
# }

# for sidebarintro.html
Exemplo n.º 3
0
# -*- coding: utf-8 -*-
import sys
import os
import sphinx_readable_theme
from pyquickhelper.helpgen.default_conf import set_sphinx_variables, get_default_stylesheet

sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))

set_sphinx_variables(__file__, "pyensae", "Xavier Dupré", 2020,
                     "readable", sphinx_readable_theme.get_html_theme_path(),
                     locals(), add_extensions=None,
                     extlinks=dict(issue=('https://github.com/sdpython/pyensae/issues/%s', 'issue')))

blog_root = "http://www.xavierdupre.fr/app/pyensae/helpsphinx/"
blog_background = False

html_context = {
    'css_files': get_default_stylesheet() + ['_static/my-styles.css'],
}

nblinks = {"code-r2python": blog_root + "pyensae/languages/rconverter.html"}

epkg_dictionary = ({
    "antlr4": 'https://github.com/antlr/antlr4',
    "blockdiag": 'http://blockdiag.com/',
    'GeoDataFrame': 'https://geopandas.org/reference/geopandas.GeoDataFrame.html',
    'geopandas': 'https://geopandas.org/',
    "json": 'https://en.wikipedia.org/wiki/JSON',
    "manydataapi": 'http://www.xavierdupre.fr/app/manydataapi/helpsphinx/index.html',
    "networkx": 'https://networkx.github.io/',
    "pyenbc": 'http://www.xavierdupre.fr/app/pyenbc/helpsphinx/index.html',
Exemplo n.º 4
0
# 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 = __version__
# The full version, including alpha/beta/rc tags.
release = __version__

# -- Options for HTML output ----------------------------------------------

html_theme = 'readable'

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [get_html_theme_path()]

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

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d'
Exemplo n.º 5
0
# -*- coding: utf-8 -*-
import sys
import os
import sphinx_readable_theme
from pyquickhelper.helpgen.default_conf import set_sphinx_variables

sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))

set_sphinx_variables(__file__, "pyensae", "Xavier Dupré", 2019,
                     "readable", sphinx_readable_theme.get_html_theme_path(),
                     locals(), add_extensions=None,
                     extlinks=dict(issue=('https://github.com/sdpython/pyensae/issues/%s', 'issue')))

blog_root = "http://www.xavierdupre.fr/app/pyensae/helpsphinx/"
blog_background = False

nblinks = {"code-r2python": blog_root + "pyensae/languages/rconverter.html"}

epkg_dictionary = ({
    "antlr4": 'https://github.com/antlr/antlr4',
    "blockdiag": 'http://blockdiag.com/',
    "json": 'https://en.wikipedia.org/wiki/JSON',
    "manydataapi": 'http://www.xavierdupre.fr/app/manydataapi/helpsphinx/index.html',
    "networkx": 'https://networkx.github.io/',
    "pyenbc": 'http://www.xavierdupre.fr/app/pyenbc/helpsphinx/index.html',
    "SQLite3": 'https://www.sqlite.org/index.html',
})