Fixed toctree and added doc github

computationalmodelling · Feb 2, 2021 · d3e0bd7 · d3e0bd7
1 parent abe1d1e
commit d3e0bd7
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 6 deletions.
diff --git a/doc/_templates/custom-template.html b/doc/_templates/custom-template.html
@@ -0,0 +1,6 @@
+<div class="sidebar-message">
+    This is a community-supported theme.
+    If you'd like to contribute,
+    <a href="https://github.com/pandas-dev/pydata-sphinx-theme">check out our GitHub repository</a>
+    Your contributions are welcome!
+</div>
diff --git a/doc/conf.py b/doc/conf.py
@@ -76,6 +76,13 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'fidimagdoc'
 
+html_theme_options = {
+    "github_url": "https://github.com/computationalmodelling/fidimag",
+    "use_edit_page_button": True,
+    "show_toc_level": 1,
+    # "navbar_align": "right",  # For testing that the navbar items align properly
+}
+
 
 # -- Options for LaTeX output --------------------------------------------
 

diff --git a/doc/physics_num_methods/index.rst b/doc/physics_num_methods/index.rst
@@ -6,7 +6,7 @@ Magnetism and Numerical Methods
    :maxdepth: 2
    :caption: Micromagnetics and Discrete Spin Model
 
-    core_eqs
-    extended_eqs
-    monte_carlo
-    nebm
+   core_eqs
+   extended_eqs
+   monte_carlo
+   nebm
diff --git a/doc/physics_num_methods/nebm.rst b/doc/physics_num_methods/nebm.rst
@@ -70,7 +70,7 @@ For a thorough explanation of the method see references [3,4].
 NEBM relaxation
 ---------------
 
-.. image:: images/nebm.png
+.. image:: ../images/nebm.png
 
 Cartesian
 ^^^^^^^^^
@@ -306,7 +306,7 @@ We have implemented three classes in Fidimag for the NEBM:
 
 The following diagram shows how the code is structured:
 
-.. image:: images/nebm_classes.png
+.. image:: ../images/nebm_classes.png
    :scale: 60 %
 
 There is a ``fidimag.common.nebm_tools`` module with common functions for the