documentation + manual

Author: AAAlvesJr

docs/conf.py

@@ -30,10 +30,14 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+import sphinx_rtd_theme
+
 extensions = ['sphinx.ext.autodoc',
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
-    'sphinxcontrib.bibtex']
+    'sphinxcontrib.bibtex',
+    #'sphinxcontrib.fulltoc',
+    "sphinx_rtd_theme"]
 
 
 # Add any paths that contain templates here, relative to this directory.
@@ -50,17 +54,17 @@
 
 # General information about the project.
 project = u'Hydra'
-copyright = u'2017, Antonio Augusto Alves Junior'
+copyright = u'2016-2020, Antonio Augusto Alves Junior'
 author = u'Antonio Augusto Alves Junior'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'2.0'
+version = u'3.X.Y'
 # The full version, including alpha/beta/rc tags.
-release = u'2.0'
+release = u'3.X.Y'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -86,14 +90,28 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'classic'
+html_theme = "sphinx_rtd_theme"#'classic'
+#html_theme_options = {
+#    "relbarbgcolor": "black",
+#    "sidebarbgcolor":"lavender",
+#    "sidebartextcolor": "black",
+#    "sidebarlinkcolor": "brown"
+#}
 html_theme_options = {
-    "relbarbgcolor": "black",
-    "sidebarbgcolor":"lavender",
-    "sidebartextcolor": "black",
-    "sidebarlinkcolor": "brown"
+    'canonical_url': '',
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': False,
+    'vcs_pageview_mode': '',
+    'style_nav_header_background': 'white',
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+     'titles_only': False
 }
-
 # 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
 # documentation.

docs/index.rst

@@ -9,9 +9,9 @@ Welcome to Hydra's manual
 =================================
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
    :caption: Contents:
-   
+
    introduction
    functors
    containers
@@ -28,4 +28,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-