Skip to content

Commit

Permalink
Merge pull request #164 from sdementen/blackify
Browse files Browse the repository at this point in the history 
reformat with black
  • Loading branch information
@sdementen
sdementen committed Apr 4, 2021
2 parents b67e4dc + 50e2b30 commit 2838de8
Show file tree
Hide file tree
Showing 58 changed files with 2,953 additions and 1,868 deletions.
167 changes: 93 additions & 74 deletions docs/source/conf.py
View file
Expand Up @@ -21,7 +21,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
import re

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

# remove gnucash files generated by doc
if os.path.exists("../example_file.gnucash"):
Expand All @@ -37,35 +37,41 @@

# 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.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinxcontrib.napoleon',
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
'sphinxcontrib.programoutput',
]

ipython_mplbackend= ""
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinxcontrib.napoleon",
"IPython.sphinxext.ipython_console_highlighting",
"IPython.sphinxext.ipython_directive",
"sphinxcontrib.programoutput",
]

ipython_mplbackend = ""
# import piecash and set the folder with gnucash books
ipython_execlines = ['from piecash import *',
'import os',
'root = os.path.abspath(os.curdir).rsplit("docs",1)[0]',
'gnucash_books = os.path.join(root, "gnucash_books", "")']
ipython_execlines = [
"from piecash import *",
"import os",
'root = os.path.abspath(os.curdir).rsplit("docs",1)[0]',
'gnucash_books = os.path.join(root, "gnucash_books", "")',
]

# show todos
todo_include_todos = True

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

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

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

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

# General information about the project.
project = metadata.project
Expand All @@ -82,55 +88,56 @@

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# 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 = ['tutorial/existing_objects', 'tutorial/new_objects']
exclude_patterns = ["tutorial/existing_objects", "tutorial/new_objects"]

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

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# 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
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []


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

# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
on_rtd = os.environ.get("READTHEDOCS", None) == "True"

if not on_rtd: # only import and set the theme if we're building docs locally
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
import sphinx_rtd_theme

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


html_theme = 'nature'
html_theme = "nature"
html_theme = "sphinx_rtd_theme"
# html_theme = "classic"

Expand All @@ -143,79 +150,77 @@

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

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

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# 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
# 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']
html_static_path = ["_static"]

# 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'
# 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
# html_use_smartypants = True

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

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

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

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

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

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

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

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = 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 = ''
# html_use_opensearch = ''

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

# Output file base name for HTML help builder.
htmlhelp_basename = metadata.project_no_spaces + 'doc'
htmlhelp_basename = metadata.project_no_spaces + "doc"


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

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

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

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
Expand All @@ -224,43 +229,52 @@
# (source start file, target name, title, author,
# documentclass [howto/manual]).
latex_documents = [
('index', metadata.project_no_spaces + '.tex',
metadata.project + ' Documentation', metadata.authors_string,
'manual'),
(
"index",
metadata.project_no_spaces + ".tex",
metadata.project + " Documentation",
metadata.authors_string,
"manual",
),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

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


# -- Options for manual page output -------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', metadata.package, metadata.project + ' Documentation',
metadata.authors_string, 1)
(
"index",
metadata.package,
metadata.project + " Documentation",
metadata.authors_string,
1,
)
]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output -----------------------------------------------
Expand All @@ -269,33 +283,38 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', metadata.project_no_spaces,
metadata.project + ' Documentation', metadata.authors_string,
metadata.project_no_spaces, metadata.description, 'Miscellaneous'),
(
"index",
metadata.project_no_spaces,
metadata.project + " Documentation",
metadata.authors_string,
metadata.project_no_spaces,
metadata.description,
"Miscellaneous",
),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []

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

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('http://docs.python.org/', None),
"python": ("http://docs.python.org/", None),
}

# Extra local configuration. This is useful for placing the class description
# in the class docstring and the __init__ parameter documentation in the
# __init__ docstring. See
# <http://sphinx-doc.org/ext/autodoc.html#confval-autoclass_content> for more
# information.
autoclass_content = 'class'

autodoc_member_order = 'bysource'
autodoc_default_flags = ['members']
autoclass_content = "class"

autodoc_member_order = "bysource"
autodoc_default_flags = ["members"]
20 changes: 13 additions & 7 deletions examples/export_norme_A47.py
View file
Expand Up @@ -8,14 +8,18 @@

from piecash import open_book

if __name__ == '__main__':
if __name__ == "__main__":
this_folder = os.path.dirname(os.path.realpath(__file__))

with open_book(os.path.join(this_folder, "..", "gnucash_books", "CGT2015.gnucash"), open_if_lock=True) as book:
with open_book(
os.path.join(this_folder, "..", "gnucash_books", "CGT2015.gnucash"),
open_if_lock=True,
) as book:
transactions = book.transactions

env = jinja2.Environment(trim_blocks=True, lstrip_blocks=True)
xml = env.from_string(u"""
xml = env.from_string(
u"""
<?xml version="1.0"?>
<comptabilite>
<exercice>
Expand Down Expand Up @@ -47,10 +51,12 @@
</journal>
</exercice>
</comptabilite>
""").render(transactions=transactions,
enumerate=enumerate,
abs=abs,
)
"""
).render(
transactions=transactions,
enumerate=enumerate,
abs=abs,
)

with io.open("resultat.xml", "w", encoding="utf-8") as f:
f.write(xml)
Expand Down

0 comments on commit 2838de8

Please sign in to comment.