Merge pull request #39 from jvrana/hotfix-documentation-badges

fixed errors with documentation badges

README

@@ -3,13 +3,13 @@
 Build/Coverage Status
 ^^^^^^^^^^^^^^^^^^^^^
 
-+-------------------+------------------+---------------------+
-| Branch            | Build            | Coverage            |
-+===================+==================+=====================+
-| **master**        | |travis build|   | |Coverage Status|   |
-+-------------------+------------------+---------------------+
-| **development**   | |travis build|   | |Coverage Status|   |
-+-------------------+------------------+---------------------+
++-------------------+-----------------------+---------------------------------+
+| Branch            | Build                 | Coverage                        |
++===================+=======================+=================================+
+| **master**        | |master build|        | |Master Coverage Status|        |
++-------------------+-----------------------+---------------------------------+
+| **development**   | |development build|   | |Development Coverage Status|   |
++-------------------+-----------------------+---------------------------------+
 
 📁 ODir 📁
 ========
@@ -18,8 +18,9 @@ Dealing with paths and directories isn't rocket science, but it can be a
 pain. **ODir** allows you to build directory trees by treating your
 directory tree as a first-class object.
 
-**Documentation** can be found here
-https://opath.readthedocs.io/en/latest/
+**Github** can be found here: https://github.com/jvrana/opath
+
+**Documentation** can be found here: https://opath.readthedocs.io/en/latest/
 
 **without ODir**
 
@@ -270,17 +271,19 @@ one-liners.
     # recursively change permissions for directories
     env.abspaths.chmod(0o444)
 
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath.svg
-   :target: https://travis-ci.org/jvrana/opath
-.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=master
-   :target: https://coveralls.io/github/jvrana/opath?branch=master
+.. |travis build| image:: https://img.shields.io/travis/jvrana/OPath.svg
+   :target: https://travis-ci.org/jvrana/OPath
+.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master
+   :target: https://coveralls.io/github/jvrana/OPath?branch=master
 .. |PyPI version| image:: https://badge.fury.io/py/REPO.svg
    :target: https://badge.fury.io/py/REPO
 .. |License: MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath/master.svg
-   :target: https://travis-ci.org/jvrana/opath/master
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath/development.svg
-   :target: https://travis-ci.org/jvrana/opath/development
-.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=development
-   :target: https://coveralls.io/github/jvrana/opath?branch=development
+.. |master build| image:: https://img.shields.io/travis/jvrana/OPath/master.svg
+   :target: https://travis-ci.org/jvrana/OPath?branch=master
+.. |Master Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master
+   :target: https://coveralls.io/github/jvrana/OPath?branch=master
+.. |development build| image:: https://img.shields.io/travis/jvrana/OPath/development.svg
+   :target: https://travis-ci.org/jvrana/OPath?branch=development
+.. |Development Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=development
+   :target: https://coveralls.io/github/jvrana/OPath?branch=development

README.md

@@ -1,20 +1,22 @@
-[![travis build](https://img.shields.io/travis/jvrana/opath.svg)](https://travis-ci.org/jvrana/opath)
-[![Coverage Status](https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=master)](https://coveralls.io/github/jvrana/opath?branch=master)
+[![travis build](https://img.shields.io/travis/jvrana/OPath.svg)](https://travis-ci.org/jvrana/OPath)
+[![Coverage Status](https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master)](https://coveralls.io/github/jvrana/OPath?branch=master)
 [![PyPI version](https://badge.fury.io/py/REPO.svg)](https://badge.fury.io/py/REPO)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 
 #### Build/Coverage Status
 Branch | Build | Coverage
 :---: | :---: | :---:
-**master** | [![travis build](https://img.shields.io/travis/jvrana/opath/master.svg)](https://travis-ci.org/jvrana/opath/master) | [![Coverage Status](https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=master)](https://coveralls.io/github/jvrana/opath?branch=master)
-**development** | [![travis build](https://img.shields.io/travis/jvrana/opath/development.svg)](https://travis-ci.org/jvrana/opath/development) | [![Coverage Status](https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=development)](https://coveralls.io/github/jvrana/opath?branch=development)
+**master** | [![master build](https://img.shields.io/travis/jvrana/OPath/master.svg)](https://travis-ci.org/jvrana/OPath?branch=master) | [![Master Coverage Status](https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master)](https://coveralls.io/github/jvrana/OPath?branch=master)
+**development** | [![development build](https://img.shields.io/travis/jvrana/OPath/development.svg)](https://travis-ci.org/jvrana/OPath?branch=development) | [![Development Coverage Status](https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=development)](https://coveralls.io/github/jvrana/OPath?branch=development)
 
 # 📁 ODir 📁
 
 Dealing with paths and directories isn't rocket science, but it can be a pain. **ODir** allows you to build directory trees by treating
 your directory tree as a first-class object.
 
+**Github** can be found here: https://github.com/jvrana/opath
+
 **Documentation** can be found here https://opath.readthedocs.io/en/latest/
 
 **without ODir**

docsrc/Makefile

@@ -22,7 +22,7 @@ help:
 
 html:
 	# Remove autogenerated autosummary files. Without removal, these files will not be updated
-	rm -rf $(SOURCEDIR)/developer/_autosummary
+	rm -rf $(SOURCEDIR)/_autosummary
 
 	# build the documentation
 	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docsrc/index.rst

@@ -24,13 +24,13 @@ Build/Coverage Status
 
 OPath is currently in development (Version |Version|)
 
-+-------------------+------------------+---------------------+
-| Branch            | Build            | Coverage            |
-+===================+==================+=====================+
-| **master**        | |travis build|   | |Coverage Status|   |
-+-------------------+------------------+---------------------+
-| **development**   | |travis build|   | |Coverage Status|   |
-+-------------------+------------------+---------------------+
++-------------------+-----------------------+---------------------------------+
+| Branch            | Build                 | Coverage                        |
++===================+=======================+=================================+
+| **master**        | |master build|        | |Master Coverage Status|        |
++-------------------+-----------------------+---------------------------------+
+| **development**   | |development build|   | |Development Coverage Status|   |
++-------------------+-----------------------+---------------------------------+
 
 Installation
 ------------
@@ -201,17 +201,19 @@ API Reference
       :noindex:
 
 
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath.svg
-   :target: https://travis-ci.org/jvrana/opath
-.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=master
-   :target: https://coveralls.io/github/jvrana/opath?branch=master
+.. |travis build| image:: https://img.shields.io/travis/jvrana/OPath.svg
+   :target: https://travis-ci.org/jvrana/OPath
+.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master
+   :target: https://coveralls.io/github/jvrana/OPath?branch=master
 .. |PyPI version| image:: https://badge.fury.io/py/REPO.svg
    :target: https://badge.fury.io/py/REPO
 .. |License: MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath/master.svg
-   :target: https://travis-ci.org/jvrana/opath/master
-.. |travis build| image:: https://img.shields.io/travis/jvrana/opath/development.svg
-   :target: https://travis-ci.org/jvrana/opath/development
-.. |Coverage Status| image:: https://coveralls.io/repos/github/jvrana/opath/badge.svg?branch=development
-   :target: https://coveralls.io/github/jvrana/opath?branch=development
+.. |master build| image:: https://img.shields.io/travis/jvrana/OPath/master.svg
+   :target: https://travis-ci.org/jvrana/OPath?branch=master
+.. |Master Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=master
+   :target: https://coveralls.io/github/jvrana/OPath?branch=master
+.. |development build| image:: https://img.shields.io/travis/jvrana/OPath/development.svg
+   :target: https://travis-ci.org/jvrana/OPath?branch=development
+.. |Development Coverage Status| image:: https://coveralls.io/repos/github/jvrana/OPath/badge.svg?branch=development
+   :target: https://coveralls.io/github/jvrana/OPath?branch=development

opath/objchain.py

@@ -54,7 +54,6 @@ class ObjChain(object):
 
         root.child1.child2.child3 # etc.
 
-    New nodes can be 'pushed_up'
     """
 
     def __init__(self, push_up=False, check_attr=True):
@@ -280,11 +279,6 @@ def _create_and_add_child(self, attr, with_attributes=None, push_up=None, check_
         :type with_attributes: dict
         :param push_up: whether to push the new node to root.
         :type push_up: boolean
-<<<<<<< HEAD:magicdir/magicchain.py
-        :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will
-        default to defaults defined on initialization
-        :type check_attr: boolean|None
-=======
         :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will default to defaults defined on initialization
         :type check_attr: boolean or None
         :return: the newly added child node

opath/opath.py

@@ -19,11 +19,7 @@ class OPath(ObjChain):
 
     def __init__(self, name, push_up=True, check_attr=True):
         """
-<<<<<<< HEAD:magicdir/magic_dir.py
-        Initializer for MagicPath
-=======
         Initializer for OPath
->>>>>>> refactoring:opath/opath.py
 
         :param name: basename of the path
         :type name: str
@@ -303,8 +299,7 @@ def add(self, name, attr=None, push_up=None, check_attr=None):
         :type attr: basestring
         :param push_up: whether to 'push' attribute to the root, where it can be accessed
         :type push_up: boolean
-        :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will
-        default to defaults defined on initialization
+        :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will default to defaults defined on initialization
         :type check_attr: boolean|None
         :return: new directory
         :rtype: ODir
@@ -326,8 +321,7 @@ def add_file(self, name, attr=None, push_up=None, check_attr=False):
         :type attr: basestring
         :param push_up: whether to 'push' attribute to the root, where it can be accessed
         :type push_up: boolean
-        :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will
-        default to defaults defined on initialization
+        :param check_attr: if True, will raise exception if attr is not a valid attribute. If None, value will default to defaults defined on initialization
         :type check_attr: boolean|None
         :return: new directory
         :rtype: ODir