diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..44391a5 --- /dev/null +++ b/.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. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 4246906..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,134 +0,0 @@ - -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? Here's how to set up ``rooki`` for local development. - - -#. Fork the ``rooki`` repo on GitHub. -#. - Clone your fork locally: - - $ git clone git@github.com:your_name_here/rooki.git - -#. - Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development: - - $ mkvirtualenv rooki - $ cd rooki/ - $ python setup.py develop - -#. - Create a branch for local development: - - $ git checkout -b name-of-your-bugfix-or-feature - - Now you can make your changes locally. - -#. - When you are done making changes, check that your changes pass flake8 and the - tests, including testing other Python versions with tox: - - $ flake8 rooki tests - $ python setup.py test or py.test - $ tox - - To get flake8 and tox, just pip install them into your virtualenv. - -#. - Commit your changes and push your branch to GitHub: - - $ git add . - $ git commit -m "Your detailed description of your changes." - $ git push origin name-of-your-bugfix-or-feature - -#. - Submit a pull request through the GitHub website. - -Pull Request Guidelines ------------------------ - -Before you submit a pull request, check that it meets these guidelines: - - -#. The pull request should include tests. -#. If the pull request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring, and add the - feature to the list in README.rst. -#. The pull request should work for Python 3.6 and above. Check - https://travis-ci.org/roocs/rooki/pull_requests - and make sure that the tests pass for all supported Python versions. - -Tips ----- - -To run a subset of tests:: - - $ py.test tests.test_rooki - -Deploying ---------- - -A reminder for the maintainers on how to deploy. -Make sure all your changes are committed (including an entry in HISTORY.rst). -Then run: - -.. code-block:: console - - $ bumpversion patch # possible: major / minor / patch - $ git push - $ git push --tags - -Travis will then deploy to PyPI if tests pass. diff --git a/HISTORY.rst b/HISTORY.rst index 35c7919..14d1ae8 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,10 +1,11 @@ -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. @@ -12,7 +13,7 @@ Changes: * Result object to access MetaLink outputs. * Notebooks with usage examples. -0.1.0 (2020-03-19) -================== +v0.1.0 (2020-03-19) +------------------- * First release. diff --git a/docs/environment.yml b/docs/environment.yml index 57aa8de..5d456b3 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,4 +6,5 @@ channels: dependencies: - sphinx - nbsphinx +- pandoc - ipython diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico new file mode 100644 index 0000000..4facff7 Binary files /dev/null and b/docs/source/_static/favicon.ico differ diff --git a/docs/source/_static/roocs.png b/docs/source/_static/roocs.png new file mode 100644 index 0000000..eb41e1f Binary files /dev/null and b/docs/source/_static/roocs.png differ diff --git a/docs/source/conf.py b/docs/source/conf.py index af72fac..a15bfee 100755 --- a/docs/source/conf.py +++ b/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,9 +142,7 @@ # (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"), ] @@ -146,11 +150,7 @@ # 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", + ), ] diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index ac7b6bc..faee540 100644 --- a/docs/source/contributing.rst +++ b/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. diff --git a/docs/source/development.rst b/docs/source/development.rst index 8700980..51941e5 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -1,5 +1,7 @@ -Development -=========== +.. _dev_guide: + +Development Guide +================= Get Started! ------------ diff --git a/docs/source/index.rst b/docs/source/index.rst index 68cb714..715dc31 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,4 +9,5 @@ usage development notebooks/index + contributing history diff --git a/requirements_dev.txt b/requirements_dev.txt index 7ef41a6..d089fdf 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -9,7 +9,7 @@ Sphinx>=1.8.1 nbsphinx>=0.7.0 twine>=1.12.1 pre-commit>=2.7.1 -black>=20.0 +black>=20.8b1 pytest>=3.8.2 pytest-runner>=4.2 nbval>=0.9.6