Skip to content
This repository has been archived by the owner on Dec 18, 2024. It is now read-only.

Commit

Permalink
typo
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts committed Sep 3, 2019
1 parent 35d1833 commit 744cae4
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 39 deletions.
91 changes: 55 additions & 36 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@
import os
import sys

sys.path.insert(0, os.path.abspath(r'..'))
sys.path.insert(0, os.path.abspath(r".."))


from isogeotoxlsx.__about__ import __title__, __version__ as VERSION
from isogeotoxlsx import *

# -- Build environment -----------------------------------------------------
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
on_rtd = os.environ.get("READTHEDOCS", None) == "True"


# -- Project information -----------------------------------------------------

project = __title__
author = 'Isogeo'
copyright = u'2019 - {0}, {1}'.format(date.today().year, author)
author = "Isogeo"
copyright = "2019 - {0}, {1}".format(date.today().year, author)

# The short X.Y version
version = VERSION
Expand All @@ -47,22 +47,19 @@
# 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.viewcode',
]
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]

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

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']
source_suffix = [".rst", ".md"]


# The master toctree document.
master_doc = 'index'
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -74,19 +71,29 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "*.csv", "samples/*", "Thumbs.db", ".DS_Store",
"*env*", "libs/*", "*.xml", "input/*", "output/*"]
exclude_patterns = [
"_build",
"*.csv",
"samples/*",
"Thumbs.db",
".DS_Store",
"*env*",
"libs/*",
"*.xml",
"input/*",
"output/*",
]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"


# -- 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'
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
Expand All @@ -97,7 +104,7 @@
# 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']
html_static_path = ["_static"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand All @@ -113,7 +120,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

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


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -122,15 +129,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -140,8 +144,13 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Isogeo-XlsxExporter.tex', 'Isogeo - XLSX Exporter Documentation',
'Isogeo', 'manual'),
(
master_doc,
"Isogeo-XlsxExporter.tex",
"Isogeo - XLSX Exporter Documentation",
"Isogeo",
"manual",
)
]


Expand All @@ -150,8 +159,13 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'isogeo-xmltoolbelt', 'Isogeo - XLSX Exporter Documentation',
[author], 1)
(
master_doc,
"isogeo-export-xlsx",
"Isogeo - XLSX Exporter Documentation",
[author],
1,
)
]


Expand All @@ -161,9 +175,15 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Isogeo-XlsxExporter', 'Isogeo - XLSX Exporter Documentation',
author, 'Isogeo-XlsxExporter', 'Scripting toolbox to handle import of external geographic metadata',
'Miscellaneous'),
(
master_doc,
"Isogeo-XlsxExporter",
"Isogeo - XLSX Exporter Documentation",
author,
"Isogeo-XlsxExporter",
"Scripting toolbox to handle import of external geographic metadata",
"Miscellaneous",
)
]


Expand All @@ -182,7 +202,7 @@
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------
Expand All @@ -192,21 +212,20 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- Options for Sphinx API doc ----------------------------------------------
# run api doc
def run_apidoc(_):
from sphinx.ext.apidoc import main

cur_dir = os.path.normpath(os.path.dirname(__file__))
output_path = os.path.join(cur_dir, '_apidoc')
output_path = os.path.join(cur_dir, "_apidoc")
modules = os.path.normpath(os.path.join(cur_dir, "../isogeotoxlsx/"))
exclusions = [
'../input',
'../output',
'/tests',
]
main(['-e', '-f', '-M', '-o', output_path, modules] + exclusions)
exclusions = ["../input", "../output", "/tests"]
main(["-e", "-f", "-M", "-o", output_path, modules] + exclusions)


# launch setup
def setup(app):
app.connect('builder-inited', run_apidoc)
app.connect("builder-inited", run_apidoc)

6 changes: 3 additions & 3 deletions isogeotoxlsx/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
#! python3

"""
This package is used to export Isogeo metadata into Excel workbooks usng the Isogeo Python SDK and OpenPyXl.
This package is used to export Isogeo metadata into Excel workbooks using the Isogeo Python SDK and OpenPyXl.
"""

# submodules
from .__about__ import __version__ # noqa: F401
from .isogeo2xlsx import Isogeo2xlsx # noqa: F401

# subpackages
from .matrix import * # noqa: F401
from .utils import * # noqa: F401
from .matrix import * # noqa: F401,F403
from .utils import * # noqa: F401,F403

VERSION = __version__

0 comments on commit 744cae4

Please sign in to comment.