From cc90719620cc77a9a4de214065471036ad1c781d Mon Sep 17 00:00:00 2001
From: Rui Ribeiro <rui.ribeiro@icloud.com>
Date: Tue, 8 Nov 2022 16:55:36 +0100
Subject: [PATCH] docs
---
SSBtoolkit-Tutorial1.ipynb | 8 +++++++
docs/_static/custom.css | 15 ++++++++++++
docs/apidocs.rst | 1 -
docs/conf.py | 4 +++-
docs/index.rst | 47 ++++++++++++++++++++++++++++++++++++++
5 files changed, 73 insertions(+), 2 deletions(-)
create mode 100644 docs/_static/custom.css
diff --git a/SSBtoolkit-Tutorial1.ipynb b/SSBtoolkit-Tutorial1.ipynb
index a8976df..fb71030 100644
--- a/SSBtoolkit-Tutorial1.ipynb
+++ b/SSBtoolkit-Tutorial1.ipynb
@@ -486,6 +486,14 @@
" <img src=\"https://res.cloudinary.com/djz27k5hg/image/upload/v1642677502/logos/COFUNDED_EU_j2ktlp.jpg\" width=\"300\" align='left' style=\"margin-left:50px\">\n",
"</div> "
]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "690b7ff2",
+ "metadata": {},
+ "outputs": [],
+ "source": []
}
],
"metadata": {
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644
index 0000000..ff0b629
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,15 @@
+.wy-side-nav-search, .wy-nav-top {
+ background: #EFEFEF;
+
+}
+/* Text inside search */
+.wy-side-nav-search input[type=text] {
+ color: #000000;
+}
+
+
+/* Home button */
+.wy-side-nav-search > a {
+ color: #555753;
+ font-size: 25px;
+}
\ No newline at end of file
diff --git a/docs/apidocs.rst b/docs/apidocs.rst
index 5e709c6..df237bd 100644
--- a/docs/apidocs.rst
+++ b/docs/apidocs.rst
@@ -1,5 +1,4 @@
API Documentation
=================
-
.. automodule:: ssbtoolkit
:members:
diff --git a/docs/conf.py b/docs/conf.py
index b1c2f9a..8571d44 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,4 +53,6 @@ pygments_style = 'sphinx'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+html_static_path = ['_static']
+
+#html_css_files = ["custom.css"]
diff --git a/docs/index.rst b/docs/index.rst
index 9efec59..bd59789 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -46,6 +46,53 @@ protocols.
apidocs
faq
+\
+
+\
+
+Availability and License
+========================
+The source code is freely available at https://github.com/rribeiro-sci/SSBtoolkit under
+the Apache 2.0 license. Tutorial notebooks containing minimal working examples can be found at https://github.com/rribeiro-sci/SSBtoolkit.
+
+\
+
+\
+
+Developed by
+============
+.. image:: _static/FZJ_logo.svg
+ :width: 200
+
+\
+
+\
+
+Funded by
+=========
+.. image:: https://res.cloudinary.com/djz27k5hg/image/upload/v1637657234/logos/HBP_horizontal_logo_qtcyzn.png
+ :width: 200
+ :alt: Alternative text
+
+Citation |DOI for Citing pyGOMoDo|
+==================================
+
+pyGOMoDo is research software. If you make use of pyGOMoDo in scientific
+publications, please cite it. The BibTeX reference is
+
+::
+
+ @article{,
+ title = {},
+ author = {},
+ journal = {},
+ volume = {},
+ number = {},
+ pages = {},
+ year = {},
+ doi = {}
+ }
+
Indices and tables
==================
--
GitLab