From 97a3bbb13822de9b824c18340b4971010228d947 Mon Sep 17 00:00:00 2001 From: Seung Hyun Kim Date: Fri, 11 Mar 2022 15:32:01 -0600 Subject: [PATCH 1/7] renew documentation design to sphinx-book --- docs/conf.py | 7 ++++++- docs/requirements.txt | 3 ++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9cd8fae78..1fdeb7ba7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,12 @@ # 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_theme = 'sphinx_book_theme' +html_theme_option = { + "repository_url": "https://github.com/SophT-Team/SophT/docs", + "use_repository_button": True, +} +html_title = "PyElastica" html_logo = "https://github.com/GazzolaLab/PyElastica/blob/assets/docs/assets/Logo.png?raw=true" #pygments_style = "sphinx" diff --git a/docs/requirements.txt b/docs/requirements.txt index f7684f579..522ad88f3 100644 --- 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 From cbb8a9ec2a4ff303cc05aa9acfcfdeb0ac79ffae Mon Sep 17 00:00:00 2001 From: Seung Hyun Kim Date: Sat, 12 Mar 2022 11:07:29 -0600 Subject: [PATCH 2/7] edit repo url --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 1fdeb7ba7..f42db9129 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,7 +80,7 @@ html_theme = 'sphinx_book_theme' html_theme_option = { - "repository_url": "https://github.com/SophT-Team/SophT/docs", + "repository_url": "https://github.com/GazzolaLab/PyElastica", "use_repository_button": True, } html_title = "PyElastica" From aa366a64986b4f599a93d71740bef82b07837f3c Mon Sep 17 00:00:00 2001 From: Seung Hyun Kim Date: Sun, 20 Mar 2022 03:03:46 -0500 Subject: [PATCH 3/7] Update conf.py Fix typo --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 831462830..905e3d0c7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,7 +81,7 @@ # a list of builtin themes. html_theme = 'sphinx_book_theme' -html_theme_option = { +html_theme_options = { "repository_url": "https://github.com/GazzolaLab/PyElastica", "use_repository_button": True, } From cef4ae40a9661bf0bdb64a09b4652b8c42585f1e Mon Sep 17 00:00:00 2001 From: Seung Hyun Kim Date: Sun, 10 Apr 2022 00:09:33 -0500 Subject: [PATCH 4/7] update doc config --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 030965f76..592f12e13 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -86,7 +86,7 @@ "use_repository_button": True, } html_title = "PyElastica" -html_logo = "https://github.com/GazzolaLab/PyElastica/blob/assets/docs/assets/Logo.png?raw=true" +html_logo = "_static/assets/Logo.png" #pygments_style = "sphinx" # Add any paths that contain custom static files (such as style sheets) here, From dfdf497849fd0fdc51ffa249566da32c7056fe17 Mon Sep 17 00:00:00 2001 From: armantekinalp Date: Tue, 17 May 2022 11:36:15 -0500 Subject: [PATCH 5/7] typo:external_forces documentation --- docs/api/external_forces.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/external_forces.rst b/docs/api/external_forces.rst index 3d351abb7..fdb55b398 100644 --- 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 From ee846228db21bd51e347ffe17c1d79ee7b51b356 Mon Sep 17 00:00:00 2001 From: armantekinalp Date: Tue, 17 May 2022 11:37:07 -0500 Subject: [PATCH 6/7] typo:fix binder tutorial title --- docs/guide/pybind.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/pybind.md b/docs/guide/pybind.md index ca31ca154..54393f0da 100644 --- a/docs/guide/pybind.md +++ b/docs/guide/pybind.md @@ -1,4 +1,4 @@ -# PyBind Tutorials +# Binder Tutorials