Updated docs

vadyushkins · vadyushkins · commit be9fc3e84070 · 2021-05-31T12:05:55.000+03:00
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -26,3 +26,9 @@ th, td {
     font-size: 3rem;
     line-height: 1.25;
 }
+
+div.topic {
+    border: 1px solid #eee;
+    padding: 7px;
+    margin: 10px 0 10px 0;
+}
diff --git a/docs/about.rst b/docs/about.rst
@@ -37,7 +37,7 @@ CFPQ_Data development is guided by the following core team:
              alt="Avatar picture of @Yakonick"
            />
         </div>
-        Kovalev Nikita
+        Nikita Kovalev
      </a>
      <div class="team-member-handle">@Yakonick</div>
    </div>
diff --git a/docs/reference/grammars/grammars_converters.rst b/docs/reference/grammars/grammars_converters.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Grammar's converters
-********************
+******************
+Grammar converters
+******************
+
+.. seealso::
+
+    `Pyformlang CFG
+    <https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_
 
 .. automodule:: cfpq_data.grammars.converters
 .. autosummary::
diff --git a/docs/reference/grammars/grammars_readwrite.rst b/docs/reference/grammars/grammars_readwrite.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Grammar's readwrite
-*******************
+****************************
+Reading and writing grammars
+****************************
+
+.. seealso::
+
+    `Pyformlang CFG
+    <https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_
 
 .. automodule:: cfpq_data.grammars.readwrite
 .. autosummary::
diff --git a/docs/reference/grammars/grammars_samples.rst b/docs/reference/grammars/grammars_samples.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Grammar's samples
-*****************
+***************
+Grammar samples
+***************
+
+.. seealso::
+
+    `Pyformlang CFG
+    <https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_
 
 .. automodule:: cfpq_data.grammars.samples
 .. autosummary::
diff --git a/docs/reference/grammars/grammars_utils.rst b/docs/reference/grammars/grammars_utils.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Grammar's utils
-***************
+*****************
+Grammar utilities
+*****************
+
+.. seealso::
+
+    `Pyformlang CFG
+    <https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_
 
 .. automodule:: cfpq_data.grammars.utils
 .. autosummary::
diff --git a/docs/reference/grammars/index.rst b/docs/reference/grammars/index.rst
@@ -2,6 +2,7 @@
 
 .. currentmodule:: cfpq_data
 
+********
 Grammars
 ********
 
diff --git a/docs/reference/graphs/graphs_generators.rst b/docs/reference/graphs/graphs_generators.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Graph's generators
-******************
+****************
+Graph generators
+****************
+
+.. seealso::
+
+    `NetworkX Graph generators
+    <https://networkx.org/documentation/stable/reference/generators.html>`_
 
 .. automodule:: cfpq_data.graphs.generators
 .. autosummary::
diff --git a/docs/reference/graphs/graphs_readwrite.rst b/docs/reference/graphs/graphs_readwrite.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Graph's readwrite
-*****************
+**************************
+Reading and writing graphs
+**************************
+
+.. seealso::
+
+    `NetworkX Reading and writing graphs
+    <https://networkx.org/documentation/stable/reference/readwrite/index.html>`_
 
 .. automodule:: cfpq_data.graphs.readwrite
 .. autosummary::
diff --git a/docs/reference/graphs/graphs_utils.rst b/docs/reference/graphs/graphs_utils.rst
@@ -2,8 +2,14 @@
 
 .. currentmodule:: cfpq_data
 
-Graph's utils
-*************
+***************
+Graph utilities
+***************
+
+.. seealso::
+
+    `NetworkX Utilities
+    <https://networkx.org/documentation/stable/reference/utils.html>`_
 
 .. automodule:: cfpq_data.graphs.utils
 .. autosummary::
diff --git a/docs/reference/graphs/index.rst b/docs/reference/graphs/index.rst
@@ -2,6 +2,7 @@
 
 .. currentmodule:: cfpq_data
 
+******
 Graphs
 ******
 
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -2,6 +2,7 @@
 
 .. currentmodule:: cfpq_data
 
+*********
 Reference
 *********
 
@@ -10,8 +11,13 @@ Reference
    :Release: |release|
    :Date: |today|
 
-- :doc:`NetworkX reference <networkx:reference/index>`
-- :doc:`Pyformlang reference <pyformlang:usage>`
+.. seealso::
+
+    `NetworkX reference <https://networkx.org/documentation/stable/reference/index.html>`_
+
+.. seealso::
+
+    `Pyformlang reference <https://pyformlang.readthedocs.io/en/latest/usage.html>`_
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -13,17 +13,22 @@ Tutorial
 .. currentmodule:: cfpq_data
 
 This guide can help you start working with CFPQ_Data.
+You can download this tutorial as a Jupyter Notebook from the link at the end of the page.
 
-We use the NetworkX `MultiDiGraph
-<https://networkx.org/documentation/latest/reference/classes/multidigraph.html>`_ to represent the labeled graph.
-To familiarize yourself with this representation, see `NetworkX tutorial
-<https://networkx.org/documentation/latest/tutorial.html>`_.
+.. topic:: NetworkX
 
-We use the Pyformlang `CFG
-<https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_ to represent the
-context-free grammar.
-To familiarize yourself with this representation, see `Pyformlang usage
-<https://pyformlang.readthedocs.io/en/latest/usage.html#context-free-grammar>`_.
+    We use the NetworkX `MultiDiGraph
+    <https://networkx.org/documentation/latest/reference/classes/multidigraph.html>`_ to represent the labeled graph.
+    To familiarize yourself with this representation and find useful functions, see `NetworkX tutorial
+    <https://networkx.org/documentation/latest/tutorial.html>`_.
+
+.. topic:: Pyformlang
+
+    We use the Pyformlang `CFG
+    <https://pyformlang.readthedocs.io/en/latest/modules/context_free_grammar.html>`_ to represent
+    the context-free grammar.
+    To familiarize yourself with this representation and find useful functions, see `Pyformlang usage
+    <https://pyformlang.readthedocs.io/en/latest/usage.html#context-free-grammar>`_.
 
 All functions are documented on the :ref:`reference` page.
 
