Merge pull request #32 from roocs/update-docs

added logo and contribution guide

.github/CONTRIBUTING.md

@@ -0,0 +1,6 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated!
+Every little bit helps, and credit will always be given.
+
+Please read the [Rooki Documentation](https://rooki.readthedocs.io/en/latest/) to get started.

HISTORY.rst

@@ -1,18 +1,19 @@
-History
-*******
+Version History
+===============
 
-0.2.0 (2020-10-21)
-==================
+v0.2.0 (2020-10-26)
+-------------------
 
-Changes:
+New Features
+^^^^^^^^^^^^
 
 * Lightweight wrapper for birdy WPS client.
 * Operators to build workflow.
 * Configuration to overwrite default settings.
 * Result object to access MetaLink outputs.
 * Notebooks with usage examples.
 
-0.1.0 (2020-03-19)
-==================
+v0.1.0 (2020-03-19)
+-------------------
 
 * First release.

docs/environment.yml

@@ -6,4 +6,5 @@ channels:
 dependencies:
 - sphinx
 - nbsphinx
+- pandoc
 - ipython

docs/source/conf.py

@@ -33,31 +33,31 @@
 # 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',
-    'nbsphinx',
-    'IPython.sphinxext.ipython_console_highlighting',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "nbsphinx",
+    "IPython.sphinxext.ipython_console_highlighting",
 ]
 
 # Safer to not run the notebooks
-nbsphinx_execute = 'never'
+nbsphinx_execute = "never"
 
 # 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"
 
 # General information about the project.
-project = u'rooki'
-copyright = u"2020, Carsten Ehbrecht"
-author = u"Carsten Ehbrecht"
+project = "rooki"
+copyright = "2020, Carsten Ehbrecht"
+author = "Carsten Ehbrecht"
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout
@@ -78,10 +78,10 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to 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 = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -92,7 +92,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+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
@@ -103,13 +104,21 @@
 # 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"]
 
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = "_static/roocs.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 = "_static/favicon.ico"
 
 # -- Options for HTMLHelp output ---------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'rookidoc'
+htmlhelp_basename = "rookidoc"
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -118,15 +127,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',
@@ -136,21 +142,15 @@
 # (source start file, target name, title, author, documentclass
 # [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'rooki.tex',
-     u'rooki Documentation',
-     u'Carsten Ehbrecht', 'manual'),
+    (master_doc, "rooki.tex", "rooki Documentation", "Carsten Ehbrecht", "manual"),
 ]
 
 
 # -- Options for manual page output ------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'rooki',
-     u'rooki Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "rooki", "rooki Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------
@@ -159,10 +159,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'rooki',
-     u'rooki Documentation',
-     author,
-     'rooki',
-     'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "rooki",
+        "rooki Documentation",
+        author,
+        "rooki",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

docs/source/contributing.rst

@@ -1 +1,57 @@
-.. include:: ../../CONTRIBUTING.rst
+
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+^^^^^^^^^^^
+
+Report bugs at https://github.com/roocs/rooki/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+^^^^^^^^
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+^^^^^^^^^^^^^^^^^^
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+^^^^^^^^^^^^^^^^^^^
+
+rooki could always use more documentation, whether as part of the
+official rooki docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+^^^^^^^^^^^^^^^
+
+The best way to send feedback is to file an issue at https://github.com/roocs/rooki/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions are welcome :)
+
+Get Started!
+^^^^^^^^^^^^
+
+Ready to contribute? Read the :ref:`dev_guide` to set up ``rooki`` for local development.

docs/source/development.rst

@@ -1,5 +1,7 @@
-Development
-===========
+.. _dev_guide:
+
+Development Guide
+=================
 
 Get Started!
 ------------

docs/source/index.rst

@@ -9,4 +9,5 @@
    usage
    development
    notebooks/index
+   contributing
    history