Merge pull request #92 from GazzolaLab/doc_patch

Documentation update for v0.2.3
GazzolaLab · May 19, 2022 · fb91bfa · fb91bfa
2 parents eedbdc4 + 8f7037b
commit fb91bfa
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/docs/api/external_forces.rst b/docs/api/external_forces.rst
@@ -8,7 +8,7 @@ External Forces / Interactions
 Description
 -----------
 
-External force and environmental interaction are represented as force/torque bounaary condition at different location.
+External force and environmental interaction are represented as force/torque boundary condition at different location.
 
 .. rubric:: Available Forcing
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -80,8 +80,13 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'sphinx_rtd_theme'
-html_logo = "https://github.com/GazzolaLab/PyElastica/blob/assets/docs/assets/Logo.png?raw=true"
+html_theme = 'sphinx_book_theme'
+html_theme_options = {
+    "repository_url": "https://github.com/GazzolaLab/PyElastica",
+    "use_repository_button": True,
+}
+html_title = "PyElastica"
+html_logo = "_static/assets/Logo.png"
 #pygments_style = "sphinx"
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/guide/pybind.md → docs/guide/binder.md b/docs/guide/pybind.md → docs/guide/binder.md
@@ -1,4 +1,4 @@
-# PyBind Tutorials
+# Binder Tutorials
 
 <!-- 
 <a href="https://mybinder.org/v2/gh/GazzolaLab/PyElastica/master?filepath=examples%2FBinder%2F0_PyElastica_Tutorials_Overview.ipynb">

diff --git a/docs/index.rst b/docs/index.rst
@@ -44,7 +44,7 @@ If you are interested to contribute, please read `contribution-guide`_ first.
    guide/workflow
    guide/discretization
    guide/example_cases
-   guide/pybind
+   guide/binder
    guide/visualization
 
 .. toctree::

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,8 @@
 # File: docs/requirements.txt
 
 sphinx==4.4.0
-sphinx_rtd_theme==1.0.0
+#sphinx_rtd_theme==1.0.0
+sphinx-book-theme
 readthedocs-sphinx-search==0.1.1
 sphinx-autodoc-typehints
 myst-parser