Documentation improvements (#92)

* Fix formatting

* Use wider alignment for new rtd layout

* Restrict depth

* Condense version history links

* Fix stray unicode character

* Fix code block formatting

* Remove travis-ci since we're off it

* Fix formatting

* Address sphinx warnings

Author: fayazkhan

CHANGES.rst

@@ -1,3 +1,6 @@
+Versions releases 0.2.x & above
+###############################
+
 0.3.0 (Unreleased)
 ==================
 

CHANGES_OLD.rst

@@ -1,3 +1,6 @@
+Versions releases 0.1.x
+#######################
+
 0.1.9 (2015-09-24)
 ==================
 

docs/conf.py

@@ -65,7 +65,6 @@
 htmlhelp_basename = 'sqlalchemy_mpttdoc'
 
 html_theme_options = {
-    'travis_button': True,
     'github_button': True,
     'github_user': 'uralbash',
     'github_repo': 'sqlalchemy_mptt',

docs/index.rst

@@ -7,9 +7,7 @@ sqlalchemy_mptt
 ===============
 
 .. image:: _static/mptt_insert.jpg
-    :width: 450px
     :alt: MPTT (nested sets) INSERT
-    :align: right
 
 Library for implementing Modified Preorder Tree Traversal with your
 `SQLAlchemy` Models and working with trees of Model instances, like
@@ -36,7 +34,7 @@ API:
 ----
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
 
    sqlalchemy_mptt
 
@@ -60,6 +58,7 @@ We welcome any contribution: suggestions, ideas, commits with new
 futures, bug fixes, refactoring, docs, tests, translations, etc...
 
 If you have any questions:
+
 * Use the `Discussion board <https://github.com/uralbash/sqlalchemy_mptt/discussions>`_
 * Contact the maintainer via email: fayaz.yusuf.khan@gmail.com
 * Contact the author via email: sacrud@uralbash.ru or #sacrud IRC channel |IRC Freenode|
@@ -68,6 +67,7 @@ Changelog
 =========
 
 .. toctree::
+    :maxdepth: 1
 
     CHANGES.rst
     CHANGES_OLD.rst

sqlalchemy_mptt/mixins.py

@@ -342,7 +342,7 @@ def drilldown_tree(self, session=None, json=False, json_fields=None):
         )
 
     def path_to_root(self, session=None, order=desc):
-        """Generate path from a leaf or intermediate node to the root.
+        r"""Generate path from a leaf or intermediate node to the root.
 
         For example:
 
@@ -372,7 +372,7 @@ def path_to_root(self, session=None, order=desc):
         return self._base_order(query, order=order)
 
     def get_siblings(self, include_self=False, session=None):
-        """
+        r"""
         * https://github.com/uralbash/sqlalchemy_mptt/issues/64
         * https://django-mptt.readthedocs.io/en/latest/models.html#get-siblings-include-self-false
 
@@ -414,7 +414,7 @@ def get_siblings(self, include_self=False, session=None):
         return query
 
     def get_children(self, session=None):
-        """
+        r"""
         * https://github.com/uralbash/sqlalchemy_mptt/issues/64
         * https://github.com/django-mptt/django-mptt/blob/fd76a816e05feb5fb0fc23126d33e514460a0ead/mptt/models.py#L563
 

sqlalchemy_mptt/tests/cases/edit_node.py

@@ -4,6 +4,7 @@ def test_update_wo_move(self):
         """ Update node w/o move
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Nested sets example
             1                    1(1)22
                     _______________|___________________
@@ -52,6 +53,7 @@ def test_update_wo_move_like_sacrud_save(self):
         """ Just change attr from node w/o move
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Nested sets example
             1                    1(1)22
                     _______________|___________________
@@ -97,6 +99,7 @@ def test_insert_node(self):
         """ Insert node with parent==6
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Nested sets example
             1                    1(1)22
                     _______________|___________________
@@ -155,6 +158,7 @@ def test_insert_node_near_subtree(self):
         """ Insert node with parent==4
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Nested sets example
             1                    1(1)22
                     _______________|___________________
@@ -216,6 +220,7 @@ def test_delete_node(self):
         """ Delete node(4)
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Test delete node
             1                    1(1)22
                     _______________|___________________
@@ -269,6 +274,7 @@ def test_update_node(self):
         """ Set parent_id==5 for node(8)
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
         .. code::
+
             level           Test update node
                 1                    1(1)22
                         _______________|___________________

sqlalchemy_mptt/tests/cases/get_tree.py

@@ -281,7 +281,7 @@ def go(id):
         self.assertEqual(tree, reference_tree)
 
     def test_path_to_root(self):
-        """Generate path from a leaf or intermediate node to the root.
+        r"""Generate path from a leaf or intermediate node to the root.
 
         For example:
 

sqlalchemy_mptt/tests/cases/integrity.py

@@ -75,7 +75,7 @@ def test_level_odd_when_left_odd_and_vice_versa(self):
 
         .. code-block:: sql
 
-            SELECT id, MOD((left – level + 2) / 2) AS modulo FROM tree
+            SELECT id, MOD((left - level + 2) / 2) AS modulo FROM tree
             WHERE modulo = 1
         """
         table = self.model

sqlalchemy_mptt/tests/cases/move_node.py

@@ -79,6 +79,7 @@ def test_move_one_tree_before_another(self):
         initial state of the tree :mod:`sqlalchemy_mptt.tests.add_mptt_tree`
 
         .. code::
+
                                         <--------------------------------
                                                                         |
             level           Nested sets tree1                           |