extends documentation and changes version number

README.md

@@ -122,6 +122,18 @@ Additionally the `cpu_frequency_flag` macro is loaded. It simply resolves the ap
 by the c macro `F_CPU`.
 
 Additional `copts` can be added by concatenating `cpu_frequency_flag()` with a list of the desired `copts`, i.e. `copts = cpu_frequency_flag() + ["-DDEBUG=1"]`.
+
+
+Since `v.1.0`, the upload_script may need to be specified as an additional argument if you're using the `default_embedded_binary` macro. Possible values for this parameter are:
+
+```
+upload_script = "@AvrToolchain//:dfu_upload_script"
+
+or
+
+upload_script = "@AvrToolchain//:avrdude_upload_script"
+```
+
 Building for an ARM target device can be done by using the `default_arm_binary` macro.
 
 ```python

docs/conf.py

@@ -13,6 +13,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
+
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
@@ -35,14 +36,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'EmbeddedSystemsBuildScripts'
-copyright = '2019, Embedded Systems Department University Duisburg-Essen'
-author = 'Embedded Systems Department University Duisburg-Essen'
+project = "EmbeddedSystemsBuildScripts"
+copyright = "2020, Embedded Systems Department University Duisburg-Essen"
+author = "Embedded Systems Department University Duisburg-Essen"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = 'v0.5'
+release = "v1.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -55,22 +56,22 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.intersphinx',
-#	'sphinx.ext.pngmath',
-	'sphinx.ext.todo',
+    "sphinx.ext.intersphinx",
+    # 	'sphinx.ext.pngmath',
+    "sphinx.ext.todo",
 ]
 
 # 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'
+source_suffix = ".rst"
 
 # 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.
@@ -82,7 +83,7 @@
 # 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', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None
@@ -93,7 +94,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+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
@@ -120,7 +121,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'HtmlHelpdoc'
+htmlhelp_basename = "HtmlHelpdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -129,15 +130,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',
@@ -146,7 +144,6 @@
 # --- Breathe ----
 
 
-
 # -- Options for Epub output -------------------------------------------------
 
 # Bibliographic Dublin Core info.
@@ -162,12 +159,12 @@
 # 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 -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}